Devhub api spec changes #30007
Merged
Devhub api spec changes #30007
openapi-pipeline-app / Breaking Change(Cross-Version)
completed
Sep 12, 2024 in 4m 11s
Check `Breaking Change(Cross-Version)` detected problems
Detected: 24 Errors, 17 Warnings
The check status is neutral due to the check being suppressed by a label matching pattern BreakingChange-Approved-*.
View Azure DevOps build log for more details.
Important
To see the full list of breaking changes messages, with all the details available:
In the relevant ADO build (see the link above), find the job CrossVersionBreakingChange, then the task within, also called CrossVersionBreakingChange.
In the task's build log, search for Full list of messages.
Details
| Compared specs (v0.10.13) | new version | base version |
|---|---|---|
| iac.json | 2024-08-01-preview(be4dc0d) | 2024-05-01-preview(main) |
| workflow.json | 2024-08-01-preview(be4dc0d) | 2023-08-01(main) |
| workflow.json | 2024-08-01-preview(be4dc0d) | 2024-05-01-preview(main) |
The following breaking changes have been detected in comparison to the latest stable version
❌
❌Displaying 1 out of 1 occurrences.
| Index | Description |
|---|---|
| 1 | The new version is missing a definition that was found in the old version. Was 'DeploymentProperties' removed or renamed? New: Microsoft.DevHub/preview/2024-08-01-preview/workflow.json#L655:3 definitionsOld: Microsoft.DevHub/stable/2023-08-01/workflow.json#L526:3 |
❌
❌Displaying 21 out of 21 occurrences.
| Index | Description |
|---|---|
| 1 | The new version has a different format 'arm-id' than the previous one ''. New: common-types/resource-management/v5/types.json#L14:9 definitions.AzureEntityResource.properties.idOld: common-types/resource-management/v3/types.json#L14:9 |
| 2 | The new version has a different format 'arm-id' than the previous one ''. New: common-types/resource-management/v5/types.json#L14:9 definitions.GitHubOAuthResponse.properties.idOld: common-types/resource-management/v3/types.json#L14:9 |
| 3 | The new version has a different format 'arm-id' than the previous one ''. New: common-types/resource-management/v5/types.json#L14:9 definitions.ProxyResource.properties.idOld: common-types/resource-management/v3/types.json#L14:9 |
| 4 | The new version has a different format 'arm-id' than the previous one ''. New: common-types/resource-management/v5/types.json#L14:9 definitions.Resource.properties.idOld: common-types/resource-management/v3/types.json#L14:9 |
| 5 | The new version has a different format 'arm-id' than the previous one ''. New: common-types/resource-management/v5/types.json#L14:9 definitions.ResourceModelWithAllowedPropertySet.properties.idOld: common-types/resource-management/v3/types.json#L14:9 |
| 6 | The new version has a different format 'arm-id' than the previous one ''. New: common-types/resource-management/v5/types.json#L14:9 definitions.TrackedResource.properties.idOld: common-types/resource-management/v3/types.json#L14:9 |
| 7 | The new version has a different format 'arm-id' than the previous one ''. New: common-types/resource-management/v5/types.json#L14:9 definitions.Workflow.properties.idOld: common-types/resource-management/v3/types.json#L14:9 |
| 8 | The new version has a different format 'uri' than the previous one ''. New: common-types/resource-management/v5/types.json#L413:9 definitions.OperationListResult.properties.nextLinkOld: common-types/resource-management/v3/types.json#L411:9 |
| 9 | The new version has a different format 'uuid' than the previous one ''. New: common-types/resource-management/v5/types.json#L204:9 definitions.Identity.properties.principalIdOld: common-types/resource-management/v3/types.json#L204:9 |
| 10 | The new version has a different format 'uuid' than the previous one ''. New: common-types/resource-management/v5/types.json#L210:9 definitions.Identity.properties.tenantIdOld: common-types/resource-management/v3/types.json#L209:9 |
| 11 | The new version has a different format 'uuid' than the previous one ''. New: common-types/resource-management/v5/types.json#L632:5 parameters.SubscriptionIdParameterOld: common-types/resource-management/v3/types.json#L622:5 |
| 12 | The new version has a different format 'uuid' than the previous one ''. New: Microsoft.DevHub/preview/2024-08-01-preview/workflow.json#L126:9 paths['/subscriptions/{subscriptionId}/providers/Microsoft.DevHub/locations/{location}/githuboauth/default'].get.parametersOld: Microsoft.DevHub/stable/2023-08-01/workflow.json#L126:9 |
| 13 | The new version has a different format 'uuid' than the previous one ''. New: Microsoft.DevHub/preview/2024-08-01-preview/workflow.json#L171:9 paths['/subscriptions/{subscriptionId}/providers/Microsoft.DevHub/locations/{location}/githuboauth'].get.parametersOld: Microsoft.DevHub/stable/2023-08-01/workflow.json#L171:9 |
| 14 | The new version has a different format 'uuid' than the previous one ''. New: Microsoft.DevHub/preview/2024-08-01-preview/workflow.json#L210:9 paths['/subscriptions/{subscriptionId}/providers/Microsoft.DevHub/workflows'].get.parametersOld: Microsoft.DevHub/stable/2023-08-01/workflow.json#L210:9 |
| 15 | The new version has a different format 'uuid' than the previous one ''. New: Microsoft.DevHub/preview/2024-08-01-preview/workflow.json#L249:9 paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevHub/workflows'].get.parametersOld: Microsoft.DevHub/stable/2023-08-01/workflow.json#L249:9 |
| 16 | The new version has a different format 'uuid' than the previous one ''. New: Microsoft.DevHub/preview/2024-08-01-preview/workflow.json#L294:9 paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevHub/workflows/{workflowName}'].get.parametersOld: Microsoft.DevHub/stable/2023-08-01/workflow.json#L294:9 |
| 17 | The new version has a different format 'uuid' than the previous one ''. New: Microsoft.DevHub/preview/2024-08-01-preview/workflow.json#L334:9 paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevHub/workflows/{workflowName}'].put.parametersOld: Microsoft.DevHub/stable/2023-08-01/workflow.json#L334:9 |
| 18 | The new version has a different format 'uuid' than the previous one ''. New: Microsoft.DevHub/preview/2024-08-01-preview/workflow.json#L391:9 paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevHub/workflows/{workflowName}'].delete.parametersOld: Microsoft.DevHub/stable/2023-08-01/workflow.json#L391:9 |
| 19 | The new version has a different format 'uuid' than the previous one ''. New: Microsoft.DevHub/preview/2024-08-01-preview/workflow.json#L434:9 paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevHub/workflows/{workflowName}'].patch.parametersOld: Microsoft.DevHub/stable/2023-08-01/workflow.json#L434:9 |
| 20 | The new version has a different format 'uuid' than the previous one ''. New: Microsoft.DevHub/preview/2024-08-01-preview/workflow.json#L485:9 paths['/subscriptions/{subscriptionId}/providers/Microsoft.DevHub/locations/{location}/generatePreviewArtifacts'].post.parametersOld: Microsoft.DevHub/stable/2023-08-01/workflow.json#L485:9 |
| 21 | The new version has a different format 'uuid' than the previous one ''. New: Microsoft.DevHub/preview/2024-08-01-preview/workflow.json#L79:9 paths['/subscriptions/{subscriptionId}/providers/Microsoft.DevHub/locations/{location}/githuboauth/default/getGitHubOAuthInfo'].post.parametersOld: Microsoft.DevHub/stable/2023-08-01/workflow.json#L79:9 |
❌
❌Displaying 2 out of 2 occurrences.
| Index | Description |
|---|---|
| 1 | The read only property has changed from 'false' to 'true'. New: Microsoft.DevHub/preview/2024-08-01-preview/workflow.json#L1237:9 definitions.WorkflowRun.properties.workflowRunStatusOld: Microsoft.DevHub/stable/2023-08-01/workflow.json#L990:9 |
| 2 | The read only property has changed from 'false' to 'true'. New: Microsoft.DevHub/preview/2024-08-01-preview/workflow.json#L1242:5 definitions.WorkflowRunStatusOld: Microsoft.DevHub/stable/2023-08-01/workflow.json#L995:5 |
⚠️ 1017 - ReferenceRedirection
Displaying 1 out of 1 occurrences.
| Index | Description |
|---|---|
| 1 | The '$ref' property points to different models in the old and new versions. New: Microsoft.DevHub/preview/2024-08-01-preview/workflow.json#L719:9 definitions.GitHubWorkflowProfile.properties.deploymentPropertiesOld: Microsoft.DevHub/stable/2023-08-01/workflow.json#L589:9 |
⚠️ 1038 - AddedPath
Displaying 3 out of 3 occurrences.
| Index | Description |
|---|---|
| 1 | The new version is adding a path that was not found in the old version. New: Microsoft.DevHub/preview/2024-08-01-preview/workflow.json#L525:5 paths['/subscriptions/{subscriptionId}/providers/Microsoft.DevHub/locations/{location}/adooauth/default/getADOOAuthInfo'] |
| 2 | The new version is adding a path that was not found in the old version. New: Microsoft.DevHub/preview/2024-08-01-preview/workflow.json#L573:5 paths['/subscriptions/{subscriptionId}/providers/Microsoft.DevHub/locations/{location}/adooauth/default'] |
| 3 | The new version is adding a path that was not found in the old version. New: Microsoft.DevHub/preview/2024-08-01-preview/workflow.json#L612:5 paths['/subscriptions/{subscriptionId}/providers/Microsoft.DevHub/locations/{location}/adooauth'] |
💬 1041 - AddedPropertyInResponse
Displaying 1 out of 1 occurrences.
| Index | Description |
|---|---|
| 1 | The new version has a new property 'azurePipelineProfile' in response that was not found in the old version. New: Microsoft.DevHub/preview/2024-08-01-preview/workflow.json#L675:7 definitions.WorkflowProperties.propertiesOld: Microsoft.DevHub/stable/2023-08-01/workflow.json#L547:7 |
💬 1045 - AddedOptionalProperty
Displaying 1 out of 1 occurrences.
| Index | Description |
|---|---|
| 1 | The new version has a new optional property 'azurePipelineProfile' that was not found in the old version. New: Microsoft.DevHub/preview/2024-08-01-preview/workflow.json#L675:7 definitions.WorkflowProperties.propertiesOld: Microsoft.DevHub/stable/2023-08-01/workflow.json#L547:7 |
The following breaking changes have been detected in comparison to the latest preview version
⚠️ 1006 - RemovedDefinition
Displaying 1 out of 1 occurrences.
| Index | Description |
|---|---|
| 1 | The new version is missing a definition that was found in the old version. Was 'DeploymentProperties' removed or renamed? New: Microsoft.DevHub/preview/2024-08-01-preview/workflow.json#L655:3 definitionsOld: Microsoft.DevHub/preview/2024-05-01-preview/workflow.json#L526:3 |
⚠️ 1017 - ReferenceRedirection
Displaying 1 out of 1 occurrences.
| Index | Description |
|---|---|
| 1 | The '$ref' property points to different models in the old and new versions. New: Microsoft.DevHub/preview/2024-08-01-preview/workflow.json#L719:9 definitions.GitHubWorkflowProfile.properties.deploymentPropertiesOld: Microsoft.DevHub/preview/2024-05-01-preview/workflow.json#L589:9 |
⚠️ 1019 - RemovedEnumValue
Displaying 2 out of 2 occurrences.
| Index | Description |
|---|---|
| 1 | The new version is removing enum value(s) 'ALL' from the old version. New: Microsoft.DevHub/preview/2024-08-01-preview/iac.json#L625:9 definitions.IacTemplateProperties.properties.quickStartTemplateTypeOld: Microsoft.DevHub/preview/2024-05-01-preview/iac.json#L625:9 |
| 2 | The new version is removing enum value(s) 'ALL' from the old version. New: Microsoft.DevHub/preview/2024-08-01-preview/iac.json#L630:5 definitions.QuickStartTemplateTypeOld: Microsoft.DevHub/preview/2024-05-01-preview/iac.json#L630:5 |
⚠️ 1029 - ReadonlyPropertyChanged
Displaying 4 out of 4 occurrences.
| Index | Description |
|---|---|
| 1 | The read only property has changed from 'false' to 'true'. New: Microsoft.DevHub/preview/2024-08-01-preview/iac.json#L625:9 definitions.IacTemplateProperties.properties.quickStartTemplateTypeOld: Microsoft.DevHub/preview/2024-05-01-preview/iac.json#L625:9 |
| 2 | The read only property has changed from 'false' to 'true'. New: Microsoft.DevHub/preview/2024-08-01-preview/iac.json#L630:5 definitions.QuickStartTemplateTypeOld: Microsoft.DevHub/preview/2024-05-01-preview/iac.json#L630:5 |
| 3 | The read only property has changed from 'false' to 'true'. New: Microsoft.DevHub/preview/2024-08-01-preview/workflow.json#L1237:9 definitions.WorkflowRun.properties.workflowRunStatusOld: Microsoft.DevHub/preview/2024-05-01-preview/workflow.json#L990:9 |
| 4 | The read only property has changed from 'false' to 'true'. New: Microsoft.DevHub/preview/2024-08-01-preview/workflow.json#L1242:5 definitions.WorkflowRunStatusOld: Microsoft.DevHub/preview/2024-05-01-preview/workflow.json#L995:5 |
⚠️ 1033 - RemovedProperty
Displaying 2 out of 2 occurrences.
| Index | Description |
|---|---|
| 1 | The new version is missing a property found in the old version. Was 'numberOfStores' renamed or removed? New: Microsoft.DevHub/preview/2024-08-01-preview/iac.json#L724:7 definitions.ScaleProperty.propertiesOld: Microsoft.DevHub/preview/2024-05-01-preview/iac.json#L728:7 |
| 2 | The new version is missing a property found in the old version. Was 'scaleProperties' renamed or removed? New: Microsoft.DevHub/preview/2024-08-01-preview/iac.json#L708:7 definitions.ScaleTemplateRequest.propertiesOld: Microsoft.DevHub/preview/2024-05-01-preview/iac.json#L712:7 |
⚠️ 1038 - AddedPath
Displaying 3 out of 3 occurrences.
| Index | Description |
|---|---|
| 1 | The new version is adding a path that was not found in the old version. New: Microsoft.DevHub/preview/2024-08-01-preview/workflow.json#L525:5 paths['/subscriptions/{subscriptionId}/providers/Microsoft.DevHub/locations/{location}/adooauth/default/getADOOAuthInfo'] |
| 2 | The new version is adding a path that was not found in the old version. New: Microsoft.DevHub/preview/2024-08-01-preview/workflow.json#L573:5 paths['/subscriptions/{subscriptionId}/providers/Microsoft.DevHub/locations/{location}/adooauth/default'] |
| 3 | The new version is adding a path that was not found in the old version. New: Microsoft.DevHub/preview/2024-08-01-preview/workflow.json#L612:5 paths['/subscriptions/{subscriptionId}/providers/Microsoft.DevHub/locations/{location}/adooauth'] |
💬 1041 - AddedPropertyInResponse
Displaying 1 out of 1 occurrences.
| Index | Description |
|---|---|
| 1 | The new version has a new property 'azurePipelineProfile' in response that was not found in the old version. New: Microsoft.DevHub/preview/2024-08-01-preview/workflow.json#L675:7 definitions.WorkflowProperties.propertiesOld: Microsoft.DevHub/preview/2024-05-01-preview/workflow.json#L547:7 |
💬 1045 - AddedOptionalProperty
Displaying 2 out of 2 occurrences.
| Index | Description |
|---|---|
| 1 | The new version has a new optional property 'azurePipelineProfile' that was not found in the old version. New: Microsoft.DevHub/preview/2024-08-01-preview/workflow.json#L675:7 definitions.WorkflowProperties.propertiesOld: Microsoft.DevHub/preview/2024-05-01-preview/workflow.json#L547:7 |
| 2 | The new version has a new optional property 'scaleRequirement' that was not found in the old version. New: Microsoft.DevHub/preview/2024-08-01-preview/iac.json#L708:7 definitions.ScaleTemplateRequest.propertiesOld: Microsoft.DevHub/preview/2024-05-01-preview/iac.json#L712:7 |
Loading