Skip to content

Commit ff8bfa9

Browse files
authored
Add rule for values/keys property renaming in breaking changes guide (#45984)
1 parent cea2888 commit ff8bfa9

1 file changed

Lines changed: 17 additions & 0 deletions

File tree

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

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -311,3 +311,20 @@ Removal of multiple parameters and addition of parameters `properties` entries f
311311
**Impact**: Users can only get the property following the actual model structure which matches the REST API documentation.
312312

313313
**Resolution**: Accept these breaking changes.
314+
315+
## 12. Renaming of `values`/`keys` Properties
316+
317+
**Changelog Pattern**:
318+
319+
Removal of a property named `values` or `keys` and addition of a corresponding `values_property` or `keys_property`:
320+
321+
```md
322+
- Model `ExceptionEntry` deleted or renamed its instance variable `values`
323+
- Model `ExceptionEntry` added property `values_property`
324+
```
325+
326+
**Reason**: In the base model class of TypeSpec-based SDKs, `keys` and `values` are native method names. To avoid name conflicts, properties named `keys` or `values` are automatically renamed to `keys_property` or `values_property`.
327+
328+
**Impact**: Users need to update property access from `.values` to `.values_property` (or `.keys` to `.keys_property`).
329+
330+
**Resolution**: Accept these breaking changes.

0 commit comments

Comments
 (0)