Azure / Azure/azure-sdk-tools

[JS] Expected accpet breaking change 4

Open
#11,768 0 comments 0 reactions 0 assignees View on GitHub
needs-triage
Dominant language
C#
Stars
135
Forks
260
Avg merge
3d 1h
Merged PRs (30d)
144

Description

eg:
swagger:
```
"OperationProperties": {
"description": "Operation properties.",
"type": "object",
"properties": {}
},
"Operation": {
"description": "Operation entity.",
"type": "object",
"properties": {
"properties": {
"$ref": "#/definitions/OperationProperties",
"description": "Operation properties.",
"readOnly": true,
"x-ms-client-flatten": true
},
}
},
```
typespec:
```
model Operation {
/**
* Operation properties.
*/
@visibility(Lifecycle.Read)
properties?: OperationProperties;
}
model OperationProperties {}
```

breaking:
```
Type of parameter properties of interface Operation is changed from Record to OperationProperties
```

accept breaking: `xxx is changed from Record to Model`
note: Model is {}

Contributor guide

Open the contributing guide

Research direction

No file, test, or entry point is named. Reproduce the issue using the Swagger and TypeSpec examples, then locate the JavaScript breaking-change check that reports the type transition. Done means an empty model change from Record to a named model is accepted as an allowed breaking change.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript
Domain
tooling
Issue type
Bug
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.