Skip to content

Commit 08a4261

Browse files
Update sdk-breaking-changes-guide.md (#43756)
* Update sdk-breaking-changes-guide.md * Update doc/dev/mgmt/sdk-breaking-changes-guide.md Co-authored-by: Copilot <[email protected]> --------- Co-authored-by: Copilot <[email protected]>
1 parent 8f34059 commit 08a4261

File tree

1 file changed

+42
-7
lines changed

1 file changed

+42
-7
lines changed

doc/dev/mgmt/sdk-breaking-changes-guide.md

Lines changed: 42 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -205,16 +205,31 @@ op IotDpsResourceGetCustomized(
205205
);
206206
```
207207

208-
## 6. Removal of Unreferenced Models
208+
## 6. Common Types Upgrade
209+
210+
**Changelog Pattern**:
211+
212+
Multiple changes related to common infrastructure types such as `SystemData` and `IdentityType`:
213+
214+
```md
215+
- Deleted or renamed model `IdentityType`
216+
```
217+
218+
**Reason**: Common types are upgraded to their latest versions during TypeSpec migration.
219+
220+
**Impact**: Low impact since these are common infrastructure types rarely used directly by users.
221+
222+
**Resolution**: Accept these breaking changes.
223+
224+
## 7. Removal of Unreferenced Models
209225

210226
**Changelog Pattern**:
211227

212228
Multiple removals of unreferenced models that are typically not used in the SDK:
213229

214230
```md
215-
- Deleted or renamed model `ReplicationUsageList`
216-
- Deleted or renamed model `VaultList`
217-
- Deleted or renamed model `VaultUsageList`
231+
- Deleted or renamed model `ProxyResourceWithoutSystemData`
232+
- Deleted or renamed model `Resource`
218233
```
219234

220235
**Reason**: Unreferenced models are removed during TypeSpec migration.
@@ -223,7 +238,27 @@ Multiple removals of unreferenced models that are typically not used in the SDK:
223238

224239
**Resolution**: Accept these breaking changes.
225240

226-
## 7. Parameters Changed to Keyword-only
241+
## 8. Removal of Pageable Models
242+
243+
**Changelog Pattern**:
244+
245+
Multiple removals of models following the pattern `xxxList`:
246+
247+
```md
248+
- Deleted or renamed model `ElasticSanList`
249+
- Deleted or renamed model `SkuInformationList`
250+
- Deleted or renamed model `SnapshotList`
251+
- Deleted or renamed model `VolumeGroupList`
252+
- Deleted or renamed model `VolumeList`
253+
```
254+
255+
**Reason**: Python will not expose pageable models for list APIs.
256+
257+
**Impact**: Low impact since these models are typically not used directly by users.
258+
259+
**Resolution**: Accept these breaking changes.
260+
261+
## 9. Parameters Changed to Keyword-only
227262

228263
**Changelog Pattern**:
229264

@@ -239,7 +274,7 @@ Entries showing the usage of passing parameters positionally is disabled:
239274

240275
**Resolution**: Accept these breaking changes.
241276

242-
## 8. Removal of Parameter `if_match`
277+
## 10. Removal of Parameter `if_match`
243278

244279
**Changelog Pattern**:
245280

@@ -257,7 +292,7 @@ Removal of parameter `if_match` and addition of `etag/match_condition` for the s
257292

258293
**Resolution**: Accept these breaking changes.
259294

260-
## 9. Removal of multi-level flattened properties
295+
## 11. Removal of multi-level flattened properties
261296

262297
**Changelog Pattern**:
263298

0 commit comments

Comments
 (0)