Giters

Azure / openapi-diff

Command line tool to detect breaking changes between two openapi specifications

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

False positives for rule DefaultValueChanged

cataggar opened this issue · comments

commented

I am working on https://github.com/Azure/azure-rest-api-specs-pr/pull/15631 and have false positives for rule DefaultValueChanged.

It is claiming a different default value for definitions.PrivateCloudUpdateProperties.properties.internet for:

Before:

    "PrivateCloudUpdateProperties": {
      "type": "object",
      "description": "The properties of a private cloud resource that may be updated",
      "properties": {
        "managementCluster": {
          "description": "The default cluster used for management",
          "$ref": "#/definitions/ManagementCluster"
        },
        "internet": {
          "description": "Connectivity to internet is enabled or disabled",
          "type": "string",
          "enum": [
            "Enabled",
            "Disabled"
          ],
          "default": "Disabled",
          "x-ms-enum": {
            "name": "InternetEnum",
            "modelAsString": true
          }
        },

After:

    "PrivateCloudUpdateProperties": {
      "type": "object",
      "description": "The properties of a private cloud resource that may be updated",
      "properties": {
        "managementCluster": {
          "$ref": "#/definitions/ManagementCluster",
          "description": "The default cluster used for management"
        },
        "internet": {
          "$ref": "#/definitions/InternetEnum",
          "description": "Connectivity to internet is enabled or disabled",
          "default": "Disabled"
        },

In both cases, it is "default": "Disabled".

commented

This is not really a false positive. As a sibling property of $ref, default should be ignored and thus is "not specified" in the latter case. Also note that default is not one of the exceptions to this rule in autorest.