Skip to content

Latest commit

 

History

History
67 lines (62 loc) · 1.51 KB

1028.md

File metadata and controls

67 lines (62 loc) · 1.51 KB
Raw

1028 - ArrayCollectionFormatChanged

Description: Checks whether array's collectionFormat has changed from the previous specification.

Cause: This is considered a breaking change.

Example: Value of collectionFormat element of property a of Parameter CreateParameters changed from pipes to csv 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": "array",
          "description": "Property a.",
          "minItems": 11,
          "maxItems": 5000,
          "collectionFormat": "pipes",
          "items": {
            "type": "integer",
            "minimum": 11,
            "maximum": 21,
            "multipleOf": 4
          }
        },
        ...

New specification

{
  "swagger": "2.0",
  "info": {
    "title": "swagger",
    "description": "The Azure Management API.",
    "version": "2016-12-01",
    ...
    ...
  "definitions": {
    ...
    "CreateParameters": {
      "properties": {
        "a": {
          "type": "array",
          "description": "Property a.",
          "minItems": 11,
          "maxItems": 5000,
          "collectionFormat": "csv",
          "items": {
            "type": "integer",
            "minimum": 11,
            "maximum": 21,
            "multipleOf": 4
          }
        },
        ...