Skip to content

Latest commit

 

History

History
66 lines (61 loc) · 1.83 KB

1007.md

File metadata and controls

66 lines (61 loc) · 1.83 KB

1007 - RemovedClientParameter

Description: Checks whether any supported parameter from global parameters section is removed from the previous specification.

Cause: This is considered a breaking change.

Change Example: Parameter resourceGroupName is removed in the new version.

Old specification

{
  "swagger": "2.0",
  "info": {
    ...
    "parameters": {
    "SubscriptionIdParameter": {
      "name": "subscriptionId",
      "in": "path",
      "required": true,
      "type": "string",
      "description": "Gets subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call."
    },
    "ApiVersionParameter": {
      "name": "api-version",
      "in": "query",
      "required": true,
      "type": "string",
      "description": "Client Api Version."
    },
    "ResourceGroupName": {
      "name": "resourceGroupName",
      "in": "path",
      "required": true,
      "type": "string",
      "description": "The name of the resource group within the user's subscription. The name is case insensitive.",
      "pattern": "^[-\\w\\._\\(\\)]+$",
      "minLength": 1,
      "maxLength": 90,
      "x-ms-parameter-location": "method"
    }
    ...

New specification

{
  "swagger": "2.0",
  "info": {
    ...
    "parameters": {
    "SubscriptionIdParameter": {
      "name": "subscriptionId",
      "in": "path",
      "required": true,
      "type": "string",
      "description": "Gets subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call."
    },
    "ApiVersionParameter": {
      "name": "api-version",
      "in": "query",
      "required": true,
      "type": "string",
      "description": "Client Api Version."
    }
    ...