Skip to content

Latest commit

 

History

History
97 lines (92 loc) · 2.08 KB

1041.md

File metadata and controls

97 lines (92 loc) · 2.08 KB

1041 - AddedPropertyInResponse

Description: Checks whether a property is added to the response model from the previous specification.

Cause: This is considered a breaking change.

Example: Property c is being added into model Parameters from response direction.

Old specification

{
  "swagger": "2.0",
  "info": {
    "title": "swagger",
    "description": "The Azure Management API.",
    "version": "2016-12-01",
    ...
    ...
  "paths:" {
    "/subscriptions/{subscriptionId}/providers/Microsoft.Contoso/resource1": {
      "get": {
        ...
        "responses": {
          "200": {
            "schema": {
              "$ref": "#/definitions/Parameters"
            }
          }
        }
      }
  }
  "definitions": {
    ...
    ...
    "Parameters": {
      "properties": {
        "a": {
          "type": "string",
          "description": "Required. Property a."
        },
        "b": {
          "type": "string",
          "description": "Required. Enum Property b.",
          "enum": [ "b1", "b2" ]
        }
      },
      "description": "The parameters used when get operation."
    },
    ...  

New specification

{
  "swagger": "2.0",
  "info": {
    "title": "swagger",
    "description": "The Azure Management API.",
    "version": "2016-12-01",
    ...
    ...
  "paths:" {
    "/subscriptions/{subscriptionId}/providers/Microsoft.Contoso/resource1": {
      "get": {
        ...
        "responses": {
          "200": {
            "schema": {
              "$ref": "#/definitions/Parameters"
            }
          }
        }
      }
  }
  "definitions": {
    ...
    ...
    "Parameters": {
      "properties": {
        "a": {
          "type": "string",
          "description": "Required. Property a."
        },
        "b": {
          "type": "string",
          "description": "Required. Enum Property b.",
          "enum": [ "b1", "b2" ]
        },
        "c": {
          "type": "string",
          "description": "Property c."
        }
      },
      "description": "The parameters used when get operation."
    },
    ...