Azure / Azure/azure-sdk-tools

[Breaking Change][False negative] Adding new client required parameter should be a breaking change

Open
#6,519 2 comments 0 reactions 1 assignee Claimed by @konrad-jamrozik View on GitHub
Breaking Changes Central-EngSys Spec PR Tools
Dominant language
C#
Stars
135
Forks
260
Avg merge
3d 1h
Merged PRs (30d)
143

Description

For example, as the following swagger, the first version only has two operations: `PacketCoreControlPlaneVersions_Get` and `PacketCoreControlPlaneVersions_List`, in the new version, `PacketCoreControlPlaneVersions_GetBySubscription` and `PacketCoreControlPlaneVersions_ListBySubscription` have been added. The new added parameter `SubscriptionIdParameter` is a client level parameter, which should be a breaking change.
```
"/providers/Microsoft.MobileNetwork/packetCoreControlPlaneVersions/{versionName}": {
"get": {
"tags": [
"PacketCoreControlPlaneVersion"
],
"operationId": "PacketCoreControlPlaneVersions_Get",
"description": "Gets information about the specified packet core control plane version.",
"parameters": [
{
"name": "versionName",
"in": "path",
"required": true,
"type": "string",
"description": "The name of the packet core control plane version."
},
{
"$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
}
],
"responses": {
"200": {
"description": "Request successful. The operation returns the resulting packet core control plane version resource.",
"schema": {
"$ref": "#/definitions/PacketCoreControlPlaneVersion"
}
},
"default": {
"description": "Error response describing why the operation failed.",
"schema": {
"$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"Get packet core control plane version": {
"$ref": "./examples/PacketCoreControlPlaneVersionGet.json"
}
}
}
},
"/providers/Microsoft.MobileNetwork/packetCoreControlPlaneVersions": {
"get": {
"tags": [
"PacketCoreControlPlaneVersion"
],
"operationId": "PacketCoreControlPlaneVersions_List",
"description": "Lists all supported packet core control planes versions.",
"parameters": [
{
"$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
}
],
"responses": {
"200": {
"description": "Get supported packet core control plane versions successful.",
"schema": {
"$ref": "#/definitions/PacketCoreControlPlaneVersionListResult"
}
},
"default": {
"description": "Error response describing why the operation failed.",
"schema": {
"$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"Get supported packet core control plane versions": {
"$ref": "./examples/PacketCoreControlPlaneVersionList.json"
}
},
"x-ms-pageable": {
"nextLinkName": "nextLink"
}
}
},
"/subscriptions/{subscriptionId}/providers/Microsoft.MobileNetwork/packetCoreControlPlaneVersions/{versionName}": {
"get": {
"tags": [
"PacketCoreControlPlaneVersion"
],
"operationId": "PacketCoreControlPlaneVersions_GetBySubscription",
"description": "Gets information about the specified packet core control plane version.",
"parameters": [
{
"name": "versionName",
"in": "path",
"required": true,
"type": "string",
"description": "The name of the packet core control plane version."
},
{
"$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
}
],
"responses": {
"200": {
"description": "Request successful. The operation returns the resulting packet core control plane version resource.",
"schema": {
"$ref": "#/definitions/PacketCoreControlPlaneVersion"
}
},
"default": {
"description": "Error response describing why the operation failed.",
"schema": {
"$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"Get packet core control plane version by subscription": {
"$ref": "./examples/PacketCoreControlPlaneVersionGetBySubscription.json"
}
}
}
},
"/subscriptions/{subscriptionId}/providers/Microsoft.MobileNetwork/packetCoreControlPlaneVersions": {
"get": {
"tags": [
"PacketCoreControlPlaneVersion"
],
"operationId": "PacketCoreControlPlaneVersions_ListBySubscription",
"description": "Lists all supported packet core control planes versions.",
"parameters": [
{
"$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
}
],
"responses": {
"200": {
"description": "Get supported packet core control plane versions successful.",
"schema": {
"$ref": "#/definitions/PacketCoreControlPlaneVersionListResult"
}
},
"default": {
"description": "Error response describing why the operation failed.",
"schema": {
"$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"Get supported packet core control plane versions by subscription": {
"$ref": "./examples/PacketCoreControlPlaneVersionListBySubscription.json"
}
},
"x-ms-pageable": {
"nextLinkName": "nextLink"
}
}
}
```

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.