[Cosmos DB] Microsoft.DocumentDB New API Version 2024-05-15 #28367
openapi-pipeline-app / Breaking Change(Cross-Version)
completed
May 11, 2024 in 2m 45s
Check `Breaking Change(Cross-Version)` detected problems
Detected: 5 Errors, 133 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.8) | new version | base version |
|---|---|---|
| cosmos-db.json | 2024-05-15(e06ce01) | 2023-11-15(main) |
| cosmos-db.json | 2024-05-15(e06ce01) | 2024-02-15-preview(main) |
| managedCassandra.json | 2024-05-15(e06ce01) | 2023-11-15(main) |
| managedCassandra.json | 2024-05-15(e06ce01) | 2024-02-15-preview(main) |
| mongorbac.json | 2024-05-15(e06ce01) | 2023-11-15(main) |
| mongorbac.json | 2024-05-15(e06ce01) | 2024-02-15-preview(main) |
| notebook.json | 2024-05-15(e06ce01) | 2023-11-15(main) |
| notebook.json | 2024-05-15(e06ce01) | 2024-02-15-preview(main) |
| privateEndpointConnection.json | 2024-05-15(e06ce01) | 2023-11-15(main) |
| privateEndpointConnection.json | 2024-05-15(e06ce01) | 2024-02-15-preview(main) |
| privateLinkResources.json | 2024-05-15(e06ce01) | 2023-11-15(main) |
| privateLinkResources.json | 2024-05-15(e06ce01) | 2024-02-15-preview(main) |
| rbac.json | 2024-05-15(e06ce01) | 2023-11-15(main) |
| rbac.json | 2024-05-15(e06ce01) | 2024-02-15-preview(main) |
| restorable.json | 2024-05-15(e06ce01) | 2023-11-15(main) |
| restorable.json | 2024-05-15(e06ce01) | 2024-02-15-preview(main) |
| services.json | 2024-05-15(e06ce01) | 2023-11-15(main) |
| services.json | 2024-05-15(e06ce01) | 2024-02-15-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 'required' status changed from the old version('False') to the new version('True'). New: Microsoft.DocumentDB/stable/2024-05-15/services.json#L332:7 Old: Microsoft.DocumentDB/stable/2023-11-15/services.json#L331:7 |
❌
❌Displaying 2 out of 2 occurrences.
| Index | Description |
|---|---|
| 1 | The new version has a different discriminator than the previous one. New: Microsoft.DocumentDB/stable/2024-05-15/services.json#L322:9 Old: Microsoft.DocumentDB/stable/2023-11-15/services.json#L322:9 |
| 2 | The new version has a different discriminator than the previous one. New: Microsoft.DocumentDB/stable/2024-05-15/services.json#L328:5 Old: Microsoft.DocumentDB/stable/2023-11-15/services.json#L328:5 |
❌
❌Displaying 2 out of 2 occurrences.
| Index | Description |
|---|---|
| 1 | The new version has new required property 'serviceType' that was not found in the old version. New: Microsoft.DocumentDB/stable/2024-05-15/services.json#L322:9 Old: Microsoft.DocumentDB/stable/2023-11-15/services.json#L322:9 |
| 2 | The new version has new required property 'serviceType' that was not found in the old version. New: Microsoft.DocumentDB/stable/2024-05-15/services.json#L328:5 Old: Microsoft.DocumentDB/stable/2023-11-15/services.json#L328:5 |
💬 1020 - AddedEnumValue
Displaying 1 out of 1 occurrences.
| Index | Description |
|---|---|
| 1 | The new version is adding enum value(s) '5.0, 6.0' from the old version. New: Microsoft.DocumentDB/stable/2024-05-15/cosmos-db.json#L9617:9 Old: Microsoft.DocumentDB/stable/2023-11-15/cosmos-db.json#L9617:9 |
💬 1040 - AddedReadOnlyPropertyInResponse
Displaying 1 out of 1 occurrences.
| Index | Description |
|---|---|
| 1 | The new version has a new read-only property 'privateLinkResourceId' in response that was not found in the old version. New: Microsoft.DocumentDB/stable/2024-05-15/managedCassandra.json#L833:11 Old: Microsoft.DocumentDB/stable/2023-11-15/managedCassandra.json#L833:11 |
💬 1041 - AddedPropertyInResponse
Displaying 2 out of 2 occurrences.
| Index | Description |
|---|---|
| 1 | The new version has a new property 'azureConnectionMethod' in response that was not found in the old version. New: Microsoft.DocumentDB/stable/2024-05-15/managedCassandra.json#L833:11 Old: Microsoft.DocumentDB/stable/2023-11-15/managedCassandra.json#L833:11 |
| 2 | The new version has a new property 'privateEndpointIpAddress' in response that was not found in the old version. New: Microsoft.DocumentDB/stable/2024-05-15/managedCassandra.json#L1302:11 Old: Microsoft.DocumentDB/stable/2023-11-15/managedCassandra.json#L1277:11 |
💬 1045 - AddedOptionalProperty
Displaying 1 out of 1 occurrences.
| Index | Description |
|---|---|
| 1 | The new version has a new optional property 'dedicatedGatewayType' that was not found in the old version. New: Microsoft.DocumentDB/stable/2024-05-15/services.json#L465:7 Old: Microsoft.DocumentDB/stable/2023-11-15/services.json#L424:7 |
The following breaking changes have been detected in comparison to the latest preview version
⚠️ 1005 - RemovedPath
Displaying 15 out of 24 occurrences.
| Index | Description |
|---|---|
| 1 | The new version is missing a path that was found in the old version. Was path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/cassandraClusters/{clusterName}/backups' removed or restructured? Old: Microsoft.DocumentDB/preview/2024-02-15-preview/managedCassandra.json#L490:5 |
| 2 | The new version is missing a path that was found in the old version. Was path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/cassandraClusters/{clusterName}/backups/{backupId}' removed or restructured? Old: Microsoft.DocumentDB/preview/2024-02-15-preview/managedCassandra.json#L532:5 |
| 3 | The new version is missing a path that was found in the old version. Was path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/cassandraClusters/{clusterName}/commands' removed or restructured? Old: Microsoft.DocumentDB/preview/2024-02-15-preview/managedCassandra.json#L406:5 |
| 4 | The new version is missing a path that was found in the old version. Was path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/cassandraClusters/{clusterName}/commands/{commandId}' removed or restructured? Old: Microsoft.DocumentDB/preview/2024-02-15-preview/managedCassandra.json#L448:5 |
| 5 | The new version is missing a path that was found in the old version. Was path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/cassandraClusters/{clusterName}/invokeCommandAsync' removed or restructured? Old: Microsoft.DocumentDB/preview/2024-02-15-preview/managedCassandra.json#L344:5 |
| 6 | The new version is missing a path that was found in the old version. Was path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/cassandraKeyspaces/{keyspaceName}/views' removed or restructured? Old: Microsoft.DocumentDB/preview/2024-02-15-preview/cosmos-db.json#L6848:5 |
| 7 | The new version is missing a path that was found in the old version. Was path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/cassandraKeyspaces/{keyspaceName}/views/{viewName}' removed or restructured? Old: Microsoft.DocumentDB/preview/2024-02-15-preview/cosmos-db.json#L6887:5 |
| 8 | The new version is missing a path that was found in the old version. Was path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/cassandraKeyspaces/{keyspaceName}/views/{viewName}/throughputSettings/default' removed or restructured? Old: Microsoft.DocumentDB/preview/2024-02-15-preview/cosmos-db.json#L7037:5 |
| 9 | The new version is missing a path that was found in the old version. Was path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/cassandraKeyspaces/{keyspaceName}/views/{viewName}/throughputSettings/default/migrateToAutoscale' removed or restructured? Old: Microsoft.DocumentDB/preview/2024-02-15-preview/cosmos-db.json#L7136:5 |
| 10 | The new version is missing a path that was found in the old version. Was path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/cassandraKeyspaces/{keyspaceName}/views/{viewName}/throughputSettings/default/migrateToManualThroughput' removed or restructured? Old: Microsoft.DocumentDB/preview/2024-02-15-preview/cosmos-db.json#L7195:5 |
| 11 | The new version is missing a path that was found in the old version. Was path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/graphs' removed or restructured? Old: Microsoft.DocumentDB/preview/2024-02-15-preview/cosmos-db.json#L1499:5 |
| 12 | The new version is missing a path that was found in the old version. Was path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/graphs/{graphName}' removed or restructured? Old: Microsoft.DocumentDB/preview/2024-02-15-preview/cosmos-db.json#L1535:5 |
| 13 | The new version is missing a path that was found in the old version. Was path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/mongodbDatabases/{databaseName}/collections/{collectionName}/partitionMerge' removed or restructured? Old: Microsoft.DocumentDB/preview/2024-02-15-preview/cosmos-db.json#L4545:5 |
| 14 | The new version is missing a path that was found in the old version. Was path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/mongodbDatabases/{databaseName}/collections/{collectionName}/throughputSettings/default/redistributeThroughput' removed or restructured? Old: Microsoft.DocumentDB/preview/2024-02-15-preview/cosmos-db.json#L4217:5 |
| 15 | The new version is missing a path that was found in the old version. Was path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/mongodbDatabases/{databaseName}/collections/{collectionName}/throughputSettings/default/retrieveThroughputDistribution' removed or restructured? Old: Microsoft.DocumentDB/preview/2024-02-15-preview/cosmos-db.json#L4146:5 |
⚠️ 1006 - RemovedDefinition
Displaying 15 out of 17 occurrences.
| Index | Description |
|---|---|
| 1 | The new version is missing a definition that was found in the old version. Was 'CassandraViewCreateUpdateParameters' removed or renamed? New: Microsoft.DocumentDB/stable/2024-05-15/cosmos-db.json#L5823:3 Old: Microsoft.DocumentDB/preview/2024-02-15-preview/cosmos-db.json#L7255:3 |
| 2 | The new version is missing a definition that was found in the old version. Was 'CassandraViewCreateUpdateProperties' removed or renamed? New: Microsoft.DocumentDB/stable/2024-05-15/cosmos-db.json#L5823:3 Old: Microsoft.DocumentDB/preview/2024-02-15-preview/cosmos-db.json#L7255:3 |
| 3 | The new version is missing a definition that was found in the old version. Was 'CassandraViewResource' removed or renamed? New: Microsoft.DocumentDB/stable/2024-05-15/cosmos-db.json#L5823:3 Old: Microsoft.DocumentDB/preview/2024-02-15-preview/cosmos-db.json#L7255:3 |
| 4 | The new version is missing a definition that was found in the old version. Was 'DefaultPriorityLevel' removed or renamed? New: Microsoft.DocumentDB/stable/2024-05-15/cosmos-db.json#L5823:3 Old: Microsoft.DocumentDB/preview/2024-02-15-preview/cosmos-db.json#L7255:3 |
| 5 | The new version is missing a definition that was found in the old version. Was 'DiagnosticLogSettings' removed or renamed? New: Microsoft.DocumentDB/stable/2024-05-15/cosmos-db.json#L5823:3 Old: Microsoft.DocumentDB/preview/2024-02-15-preview/cosmos-db.json#L7255:3 |
| 6 | The new version is missing a definition that was found in the old version. Was 'GraphResource' removed or renamed? New: Microsoft.DocumentDB/stable/2024-05-15/cosmos-db.json#L5823:3 Old: Microsoft.DocumentDB/preview/2024-02-15-preview/cosmos-db.json#L7255:3 |
| 7 | The new version is missing a definition that was found in the old version. Was 'GraphResourceCreateUpdateParameters' removed or renamed? New: Microsoft.DocumentDB/stable/2024-05-15/cosmos-db.json#L5823:3 Old: Microsoft.DocumentDB/preview/2024-02-15-preview/cosmos-db.json#L7255:3 |
| 8 | The new version is missing a definition that was found in the old version. Was 'GraphResourceCreateUpdateProperties' removed or renamed? New: Microsoft.DocumentDB/stable/2024-05-15/cosmos-db.json#L5823:3 Old: Microsoft.DocumentDB/preview/2024-02-15-preview/cosmos-db.json#L7255:3 |
| 9 | The new version is missing a definition that was found in the old version. Was 'MaterializedViewDefinition' removed or renamed? New: Microsoft.DocumentDB/stable/2024-05-15/cosmos-db.json#L5823:3 Old: Microsoft.DocumentDB/preview/2024-02-15-preview/cosmos-db.json#L7255:3 |
| 10 | The new version is missing a definition that was found in the old version. Was 'MergeParameters' removed or renamed? New: Microsoft.DocumentDB/stable/2024-05-15/cosmos-db.json#L5823:3 Old: Microsoft.DocumentDB/preview/2024-02-15-preview/cosmos-db.json#L7255:3 |
| 11 | The new version is missing a definition that was found in the old version. Was 'RedistributeThroughputParameters' removed or renamed? New: Microsoft.DocumentDB/stable/2024-05-15/cosmos-db.json#L5823:3 Old: Microsoft.DocumentDB/preview/2024-02-15-preview/cosmos-db.json#L7255:3 |
| 12 | The new version is missing a definition that was found in the old version. Was 'RedistributeThroughputProperties' removed or renamed? New: Microsoft.DocumentDB/stable/2024-05-15/cosmos-db.json#L5823:3 Old: Microsoft.DocumentDB/preview/2024-02-15-preview/cosmos-db.json#L7255:3 |
| 13 | The new version is missing a definition that was found in the old version. Was 'RedistributeThroughputPropertiesResource' removed or renamed? New: Microsoft.DocumentDB/stable/2024-05-15/cosmos-db.json#L5823:3 Old: Microsoft.DocumentDB/preview/2024-02-15-preview/cosmos-db.json#L7255:3 |
| 14 | The new version is missing a definition that was found in the old version. Was 'RetrieveThroughputParameters' removed or renamed? New: Microsoft.DocumentDB/stable/2024-05-15/cosmos-db.json#L5823:3 Old: Microsoft.DocumentDB/preview/2024-02-15-preview/cosmos-db.json#L7255:3 |
| 15 | The new version is missing a definition that was found in the old version. Was 'RetrieveThroughputProperties' removed or renamed? New: Microsoft.DocumentDB/stable/2024-05-15/cosmos-db.json#L5823:3 Old: Microsoft.DocumentDB/preview/2024-02-15-preview/cosmos-db.json#L7255:3 |
⚠️ 1007 - RemovedClientParameter
Displaying 4 out of 4 occurrences.
| Index | Description |
|---|---|
| 1 | The new version is missing a client parameter that was found in the old version. Was 'commandId' removed or renamed? New: Microsoft.DocumentDB/stable/2024-05-15/managedCassandra.json#L695:3 Old: Microsoft.DocumentDB/preview/2024-02-15-preview/managedCassandra.json#L928:3 |
| 2 | The new version is missing a client parameter that was found in the old version. Was 'forceDeallocate' removed or renamed? New: Microsoft.DocumentDB/stable/2024-05-15/managedCassandra.json#L695:3 Old: Microsoft.DocumentDB/preview/2024-02-15-preview/managedCassandra.json#L928:3 |
| 3 | The new version is missing a client parameter that was found in the old version. Was 'graphResourceNameParameter' removed or renamed? New: Microsoft.DocumentDB/stable/2024-05-15/cosmos-db.json#L10049:3 Old: Microsoft.DocumentDB/preview/2024-02-15-preview/cosmos-db.json#L12063:3 |
| 4 | The new version is missing a client parameter that was found in the old version. Was 'viewNameParameter' removed or renamed? New: Microsoft.DocumentDB/stable/2024-05-15/cosmos-db.json#L10049:3 Old: Microsoft.DocumentDB/preview/2024-02-15-preview/cosmos-db.json#L12063:3 |
⚠️ 1023 - TypeFormatChanged
Displaying 15 out of 22 occurrences.
⚠️ 1025 - RequiredStatusChange
Displaying 1 out of 1 occurrences.
| Index | Description |
|---|---|
| 1 | The 'required' status changed from the old version('False') to the new version('True'). New: Microsoft.DocumentDB/stable/2024-05-15/services.json#L332:7 Old: Microsoft.DocumentDB/preview/2024-02-15-preview/services.json#L321:7 |
⚠️ 1030 - DifferentDiscriminator
Displaying 2 out of 2 occurrences.
| Index | Description |
|---|---|
| 1 | The new version has a different discriminator than the previous one. New: Microsoft.DocumentDB/stable/2024-05-15/services.json#L322:9 Old: Microsoft.DocumentDB/preview/2024-02-15-preview/services.json#L312:9 |
| 2 | The new version has a different discriminator than the previous one. New: Microsoft.DocumentDB/stable/2024-05-15/services.json#L328:5 Old: Microsoft.DocumentDB/preview/2024-02-15-preview/services.json#L318:5 |
⚠️ 1033 - RemovedProperty
Displaying 15 out of 60 occurrences.
⚠️ 1034 - AddedRequiredProperty
Displaying 2 out of 2 occurrences.
| Index | Description |
|---|---|
| 1 | The new version has new required property 'serviceType' that was not found in the old version. New: Microsoft.DocumentDB/stable/2024-05-15/services.json#L322:9 Old: Microsoft.DocumentDB/preview/2024-02-15-preview/services.json#L312:9 |
| 2 | The new version has new required property 'serviceType' that was not found in the old version. New: Microsoft.DocumentDB/stable/2024-05-15/services.json#L328:5 Old: Microsoft.DocumentDB/preview/2024-02-15-preview/services.json#L318:5 |
⚠️ 1046 - RemovedOptionalParameter
Displaying 1 out of 1 occurrences.
| Index | Description |
|---|---|
| 1 | The optional parameter 'x-ms-force-deallocate' was removed in the new version. Old: Microsoft.DocumentDB/preview/2024-02-15-preview/managedCassandra.json#L821:9 |
💬 1013 - AddingHeader
Displaying 2 out of 2 occurrences.
| Index | Description |
|---|---|
| 1 | The new version adds a required header 'azure-AsyncOperation'. New: Microsoft.DocumentDB/stable/2024-05-15/services.json#L140:15 |
| 2 | The new version adds a required header 'location'. New: Microsoft.DocumentDB/stable/2024-05-15/services.json#L144:15 |
💬 1020 - AddedEnumValue
Displaying 1 out of 1 occurrences.
| Index | Description |
|---|---|
| 1 | The new version is adding enum value(s) '5.0, 6.0' from the old version. New: Microsoft.DocumentDB/stable/2024-05-15/cosmos-db.json#L9617:9 Old: Microsoft.DocumentDB/preview/2024-02-15-preview/cosmos-db.json#L11563:9 |
💬 1021 - AddedAdditionalProperties
Displaying 1 out of 1 occurrences.
| Index | Description |
|---|---|
| 1 | The new version adds an 'additionalProperties' element. New: Microsoft.DocumentDB/stable/2024-05-15/managedCassandra.json#L1227:9 Old: Microsoft.DocumentDB/preview/2024-02-15-preview/managedCassandra.json#L1534:9 |
💬 1045 - AddedOptionalProperty
Displaying 2 out of 2 occurrences.
| Index | Description |
|---|---|
| 1 | The new version has a new optional property 'dedicatedGatewayType' that was not found in the old version. New: Microsoft.DocumentDB/stable/2024-05-15/services.json#L465:7 Old: Microsoft.DocumentDB/preview/2024-02-15-preview/services.json#L414:7 |
| 2 | The new version has a new optional property 'readwrite' that was not found in the old version. New: Microsoft.DocumentDB/stable/2024-05-15/managedCassandra.json#L1222:7 Old: Microsoft.DocumentDB/preview/2024-02-15-preview/managedCassandra.json#L1529:7 |
Loading