Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Release apimanagement stable 2024-05-01 api-version #30124

Closed
wants to merge 3 commits into from

Added tag for 2024-05-01 in readme file

4552eea
Select commit
Loading
Failed to load commit list.
Closed

Release apimanagement stable 2024-05-01 api-version #30124

Added tag for 2024-05-01 in readme file
4552eea
Select commit
Loading
Failed to load commit list.
openapi-pipeline-app / Breaking Change(Cross-Version) completed Aug 8, 2024 in 15m 8s

Check `Breaking Change(Cross-Version)` detected problems

Detected: 409 Errors, 26 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
apigateway.json 2024-05-01(4552eea) 2023-09-01-preview(main)
apimallpolicies.json 2024-05-01(4552eea) 2023-09-01-preview(main)
apimanagement.json 2024-05-01(4552eea) 2022-08-01(main)
apimanagement.json 2024-05-01(4552eea) 2023-09-01-preview(main)
apimapis.json 2024-05-01(4552eea) 2022-08-01(main)
apimapis.json 2024-05-01(4552eea) 2023-09-01-preview(main)
apimapisByTags.json 2024-05-01(4552eea) 2022-08-01(main)
apimapisByTags.json 2024-05-01(4552eea) 2023-09-01-preview(main)
apimapiversionsets.json 2024-05-01(4552eea) 2022-08-01(main)
apimapiversionsets.json 2024-05-01(4552eea) 2023-09-01-preview(main)
apimauthorizationproviders.json 2024-05-01(4552eea) 2022-08-01(main)
apimauthorizationproviders.json 2024-05-01(4552eea) 2023-09-01-preview(main)
apimauthorizationservers.json 2024-05-01(4552eea) 2022-08-01(main)
apimauthorizationservers.json 2024-05-01(4552eea) 2023-09-01-preview(main)
apimbackends.json 2024-05-01(4552eea) 2022-08-01(main)
apimbackends.json 2024-05-01(4552eea) 2023-09-01-preview(main)
apimcaches.json 2024-05-01(4552eea) 2022-08-01(main)
apimcaches.json 2024-05-01(4552eea) 2023-09-01-preview(main)
apimcertificates.json 2024-05-01(4552eea) 2022-08-01(main)
apimcertificates.json 2024-05-01(4552eea) 2023-09-01-preview(main)
apimconnectivitycheck.json 2024-05-01(4552eea) 2022-08-01(main)
apimconnectivitycheck.json 2024-05-01(4552eea) 2023-09-01-preview(main)
apimcontenttypes.json 2024-05-01(4552eea) 2022-08-01(main)
apimcontenttypes.json 2024-05-01(4552eea) 2023-09-01-preview(main)
apimdeletedservices.json 2024-05-01(4552eea) 2022-08-01(main)
apimdeletedservices.json 2024-05-01(4552eea) 2023-09-01-preview(main)
apimdeployment.json 2024-05-01(4552eea) 2022-08-01(main)
apimdeployment.json 2024-05-01(4552eea) 2023-09-01-preview(main)
apimdiagnostics.json 2024-05-01(4552eea) 2022-08-01(main)
apimdiagnostics.json 2024-05-01(4552eea) 2023-09-01-preview(main)
apimdocumentations.json 2024-05-01(4552eea) 2022-08-01(main)
apimdocumentations.json 2024-05-01(4552eea) 2023-09-01-preview(main)
apimemailtemplates.json 2024-05-01(4552eea) 2022-08-01(main)
apimemailtemplates.json 2024-05-01(4552eea) 2023-09-01-preview(main)
apimgatewayConfigConnections.json 2024-05-01(4552eea) 2023-09-01-preview(main)
apimgateways.json 2024-05-01(4552eea) 2022-08-01(main)
apimgateways.json 2024-05-01(4552eea) 2023-09-01-preview(main)
apimgroups.json 2024-05-01(4552eea) 2022-08-01(main)
apimgroups.json 2024-05-01(4552eea) 2023-09-01-preview(main)
apimidentityprovider.json 2024-05-01(4552eea) 2022-08-01(main)
apimidentityprovider.json 2024-05-01(4552eea) 2023-09-01-preview(main)
apimissues.json 2024-05-01(4552eea) 2022-08-01(main)
apimissues.json 2024-05-01(4552eea) 2023-09-01-preview(main)
apimloggers.json 2024-05-01(4552eea) 2022-08-01(main)
apimloggers.json 2024-05-01(4552eea) 2023-09-01-preview(main)
apimnamedvalues.json 2024-05-01(4552eea) 2022-08-01(main)
apimnamedvalues.json 2024-05-01(4552eea) 2023-09-01-preview(main)
apimnetworkstatus.json 2024-05-01(4552eea) 2022-08-01(main)
apimnetworkstatus.json 2024-05-01(4552eea) 2023-09-01-preview(main)
apimnotifications.json 2024-05-01(4552eea) 2022-08-01(main)
apimnotifications.json 2024-05-01(4552eea) 2023-09-01-preview(main)
apimopenidconnectproviders.json 2024-05-01(4552eea) 2022-08-01(main)
apimopenidconnectproviders.json 2024-05-01(4552eea) 2023-09-01-preview(main)
apimoutbounddependency.json 2024-05-01(4552eea) 2022-08-01(main)
apimoutbounddependency.json 2024-05-01(4552eea) 2023-09-01-preview(main)
apimpolicies.json 2024-05-01(4552eea) 2022-08-01(main)
apimpolicies.json 2024-05-01(4552eea) 2023-09-01-preview(main)
apimpolicydescriptions.json 2024-05-01(4552eea) 2022-08-01(main)
apimpolicydescriptions.json 2024-05-01(4552eea) 2023-09-01-preview(main)
apimpolicyfragments.json 2024-05-01(4552eea) 2022-08-01(main)
apimpolicyfragments.json 2024-05-01(4552eea) 2023-09-01-preview(main)
apimpolicyrestrictions.json 2024-05-01(4552eea) 2023-09-01-preview(main)
apimpolicyrestrictionsvalidation.json 2024-05-01(4552eea) 2023-09-01-preview(main)
apimportalconfigs.json 2024-05-01(4552eea) 2022-08-01(main)
apimportalconfigs.json 2024-05-01(4552eea) 2023-09-01-preview(main)
apimportalrevisions.json 2024-05-01(4552eea) 2022-08-01(main)
apimportalrevisions.json 2024-05-01(4552eea) 2023-09-01-preview(main)
apimportalsettings.json 2024-05-01(4552eea) 2022-08-01(main)
apimportalsettings.json 2024-05-01(4552eea) 2023-09-01-preview(main)
apimprivatelink.json 2024-05-01(4552eea) 2022-08-01(main)
apimprivatelink.json 2024-05-01(4552eea) 2023-09-01-preview(main)
apimproducts.json 2024-05-01(4552eea) 2022-08-01(main)
apimproducts.json 2024-05-01(4552eea) 2023-09-01-preview(main)
apimproductsByTags.json 2024-05-01(4552eea) 2022-08-01(main)
apimproductsByTags.json 2024-05-01(4552eea) 2023-09-01-preview(main)
apimquotas.json 2024-05-01(4552eea) 2022-08-01(main)
apimquotas.json 2024-05-01(4552eea) 2023-09-01-preview(main)
apimregions.json 2024-05-01(4552eea) 2022-08-01(main)
apimregions.json 2024-05-01(4552eea) 2023-09-01-preview(main)
apimreports.json 2024-05-01(4552eea) 2022-08-01(main)
apimreports.json 2024-05-01(4552eea) 2023-09-01-preview(main)
apimschema.json 2024-05-01(4552eea) 2022-08-01(main)
apimschema.json 2024-05-01(4552eea) 2023-09-01-preview(main)
apimsettings.json 2024-05-01(4552eea) 2022-08-01(main)
apimsettings.json 2024-05-01(4552eea) 2023-09-01-preview(main)
apimskus.json 2024-05-01(4552eea) 2022-08-01(main)
apimskus.json 2024-05-01(4552eea) 2023-09-01-preview(main)
apimsubscriptions.json 2024-05-01(4552eea) 2022-08-01(main)
apimsubscriptions.json 2024-05-01(4552eea) 2023-09-01-preview(main)
apimtagresources.json 2024-05-01(4552eea) 2022-08-01(main)
apimtagresources.json 2024-05-01(4552eea) 2023-09-01-preview(main)
apimtags.json 2024-05-01(4552eea) 2022-08-01(main)
apimtags.json 2024-05-01(4552eea) 2023-09-01-preview(main)
apimtenant.json 2024-05-01(4552eea) 2022-08-01(main)
apimtenant.json 2024-05-01(4552eea) 2023-09-01-preview(main)
apimusers.json 2024-05-01(4552eea) 2022-08-01(main)
apimusers.json 2024-05-01(4552eea) 2023-09-01-preview(main)
apimworkspacebackends.json 2024-05-01(4552eea) 2023-09-01-preview(main)
apimworkspacecertificates.json 2024-05-01(4552eea) 2023-09-01-preview(main)
apimworkspacediagnostics.json 2024-05-01(4552eea) 2023-09-01-preview(main)
apimworkspacelinks.json 2024-05-01(4552eea) 2023-09-01-preview(main)
apimworkspaceloggers.json 2024-05-01(4552eea) 2023-09-01-preview(main)
apimworkspaces.json 2024-05-01(4552eea) 2023-09-01-preview(main)
definitions.json 2024-05-01(4552eea) 2022-08-01(main)
definitions.json 2024-05-01(4552eea) 2023-09-01-preview(main)
operationStatuses.json 2024-05-01(4552eea) 2023-09-01-preview(main)

The following breaking changes have been detected in comparison to the latest stable version

1011 - AddingResponseCode

Displaying 1 out of 2 occurrences.
⚠️ To view the remaining 1 occurrences, see the build log.

Index Description
1 The new version adds a response code '202'.
New: Microsoft.ApiManagement/stable/2024-05-01/apimapis.json#L459:11
paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}'].delete.responses.202
⚠️ 1 occurrence omitted. See the build log.

1023 - TypeFormatChanged

Displaying 1 out of 399 occurrences.
⚠️ To view the remaining 398 occurrences, see the build log.

Index Description
1 The new version has a different format 'uuid' than the previous one ''.
New: common-types/resource-management/v5/types.json#L632:5
parameters.SubscriptionIdParameter
Old: common-types/resource-management/v3/types.json#L622:5
⚠️ 398 occurrences omitted. See the build log.

1029 - ReadonlyPropertyChanged

Displaying 1 out of 6 occurrences.
⚠️ To view the remaining 5 occurrences, see the build log.

Index Description
1 The read only property has changed from 'false' to 'true'.
New: common-types/resource-management/v5/types.json#L264:9
definitions.ErrorDetail.properties.code
Old: Microsoft.ApiManagement/stable/2022-08-01/apimanagement.json#L41:9
⚠️ 5 occurrences omitted. See the build log.

1044 - XmsLongRunningOperationChanged

Displaying 1 out of 2 occurrences.
⚠️ To view the remaining 1 occurrences, see the build log.

Index Description
1 The new version has a different 'x-ms-longrunning-operation' value than the previous one.
New: Microsoft.ApiManagement/stable/2024-05-01/apimapis.json#L420:7
paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}'].delete
Old: Microsoft.ApiManagement/stable/2022-08-01/apimapis.json#L401:7
⚠️ 1 occurrence omitted. See the build log.

⚠️ 1014 - RemovingHeader

Displaying 1 out of 1 occurrences.

Index Description
1 The new version removs a required header 'Location'.
Old: Microsoft.ApiManagement/stable/2022-08-01/apimdeployment.json#L236:15
paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/backup'].post.responses.202.headers.Location

⚠️ 1017 - ReferenceRedirection

Displaying 1 out of 2 occurrences.
⚠️ To view the remaining 1 occurrences, see the build log.

Index Description
1 The '$ref' property points to different models in the old and new versions.
New: common-types/resource-management/v5/types.json#L282:11
definitions.ErrorDetail.properties.details.items
Old: Microsoft.ApiManagement/stable/2022-08-01/apimanagement.json#L80:11
⚠️ 1 occurrence omitted. See the build log.

⚠️ 1038 - AddedPath

Displaying 1 out of 13 occurrences.
⚠️ To view the remaining 12 occurrences, see the build log.

Index Description
1 The new version is adding a path that was not found in the old version.
New: Microsoft.ApiManagement/stable/2024-05-01/apimgateways.json#L1322:5
paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/gateways/{gatewayId}/invalidateDebugCredentials']
⚠️ 12 occurrences omitted. See the build log.

⚠️ 1040 - AddedReadOnlyPropertyInResponse

Displaying 1 out of 10 occurrences.
⚠️ To view the remaining 9 occurrences, see the build log.

Index Description
1 The new version has a new read-only property 'additionalInfo' in response that was not found in the old version.
New: common-types/resource-management/v5/types.json#L263:7
definitions.ErrorDetail.properties
Old: Microsoft.ApiManagement/stable/2022-08-01/apimanagement.json#L40:7
⚠️ 9 occurrences omitted. See the build log.

💬 1012 - RemovedResponseCode

Displaying 1 out of 8 occurrences.
⚠️ To view the remaining 7 occurrences, see the build log.

Index Description
1 The new version removes the response code '200'
Old: Microsoft.ApiManagement/stable/2022-08-01/apimapis.json#L440:11
paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}'].delete.responses.200
⚠️ 7 occurrences omitted. See the build log.

💬 1013 - AddingHeader

Displaying 1 out of 37 occurrences.
⚠️ To view the remaining 36 occurrences, see the build log.

Index Description
1 The new version adds a required header 'Azure-AsyncOperation'.
New: Microsoft.ApiManagement/stable/2024-05-01/apimapis.json#L3052:15
paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/schemas/{schemaId}'].put.responses.201.headers.Azure-AsyncOperation
⚠️ 36 occurrences omitted. See the build log.

💬 1020 - AddedEnumValue

Displaying 1 out of 14 occurrences.
⚠️ To view the remaining 13 occurrences, see the build log.

Index Description
1 The new version is adding enum value(s) 'BasicV2, StandardV2' from the old version.
New: Microsoft.ApiManagement/stable/2024-05-01/apimdeployment.json#L1776:9
definitions.ApiManagementServiceSkuProperties.properties.name
Old: Microsoft.ApiManagement/stable/2022-08-01/apimdeployment.json#L1615:9
⚠️ 13 occurrences omitted. See the build log.

💬 1041 - AddedPropertyInResponse

Displaying 1 out of 7 occurrences.
⚠️ To view the remaining 6 occurrences, see the build log.

Index Description
1 The new version has a new property 'appIds' in response that was not found in the old version.
New: Microsoft.ApiManagement/stable/2024-05-01/definitions.json#L1431:7
definitions.AuthorizationAccessPolicyContractProperties.properties
Old: Microsoft.ApiManagement/stable/2022-08-01/definitions.json#L1388:7
⚠️ 6 occurrences omitted. See the build log.

💬 1043 - AddingOptionalParameter

Displaying 1 out of 1 occurrences.

Index Description
1 The optional parameter 'parameters' was added in the new version.
New: Microsoft.ApiManagement/stable/2024-05-01/apimdeployment.json#L531:11
paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/migrateToStv2'].post.parameters[2]

💬 1045 - AddedOptionalProperty

Displaying 1 out of 18 occurrences.
⚠️ To view the remaining 17 occurrences, see the build log.

Index Description
1 The new version has a new optional property 'appIds' that was not found in the old version.
New: Microsoft.ApiManagement/stable/2024-05-01/definitions.json#L1431:7
definitions.AuthorizationAccessPolicyContractProperties.properties
Old: Microsoft.ApiManagement/stable/2022-08-01/definitions.json#L1388:7
⚠️ 17 occurrences omitted. See the build log.

The following breaking changes have been detected in comparison to the latest preview version

No breaking changes detected in this comparison.