Skip to content

Latest commit

 

History

History
51 lines (46 loc) · 1.33 KB

1023.md

File metadata and controls

51 lines (46 loc) · 1.33 KB

1023 - TypeFormatChanged

Description: Checks whether any existing property's format element has changed from the previous specification.

Cause: This is considered a breaking change in most cases except widening integer("int32" -> "int64") in request and narrowing integer ("int64" -> "int32") in response which are not breaking change in new api-version.

Example: Property a of Parameter CreateParameters changed format from int64 to int32 in the new version.

Old specification

{
  "swagger": "2.0",
  "info": {
    "title": "swagger",
    "description": "The Azure Management API.",
    "version": "2016-12-01",
    ...
    ...
  "definitions": {
    ...
    "CreateParameters": {
      "properties": {
        "a": {
          "type": "integer",
          "description": "Property a.",
          "format": "int64"
        },
        ...

New specification

{
  "swagger": "2.0",
  "info": {
    "title": "swagger",
    "description": "The Azure Management API.",
    "version": "2016-12-01",
    ...
    ...
  "definitions": {
    ...
    "CreateParameters": {
      "properties": {
        "a": {
          "type": "integer",
          "description": "Property a.",
          "format": "int32"
        },
        ...