pb33f / openapi-changes

The world's sexiest OpenAPI breaking changes detector. Discover what changed between two OpenAPI specs, or a single spec over time. Supports OpenAPI 3.1, 3.0 and Swagger
https://pb33f.io/openapi-changes/
Other
180 stars 16 forks source link

Is the `reportSummary` `info` changes counter wrong? #136

Open MartinX3 opened 5 months ago

MartinX3 commented 5 months ago

Is the reportSummary wrong? I see only one totalChanges and zero breakingChanges. But in changes are two entries, one with breaking true.

Only openapi and version are changed.

The generated json report:

{
    "reportSummary": {
        "info": {
            "totalChanges": 1,
            "breakingChanges": 0
        }
    },
    "changes": [
        {
            "breaking": true,
            "change": 1,
            "changeText": "modified",
            "context": {
                "originalLine": 1,
                "originalColumn": 10,
                "newLine": 1,
                "newColumn": 10
            },
            "new": "3.1.0",
            "original": "3.0.0",
            "property": "openapi"
        },
        {
            "breaking": false,
            "change": 1,
            "changeText": "modified",
            "context": {
                "originalLine": 4,
                "originalColumn": 12,
                "newLine": 4,
                "newColumn": 12
            },
            "new": "2.0.0",
            "original": "1.0.0",
            "property": "version"
        }
    ],
    "commitDetails": {
        "commitHash": "99dba0",
        "message": "New: /tmp/BD0BC4E9F73F827E65C5B9A6E5DDB78E0AEBF486/f684e9f7-f0d5-48e8-ad70-bba8f6d57299, Original: /tmp/BD0BC4E9F73F827E65C5B9A6E5DDB78E0AEBF486/339ee64d-baaa-4ed1-b08f-faed436a39e5",
        "author": "",
        "authorEmail": "",
        "committed": "2024-05-06T16:12:59.046971454+02:00",
        "changeReport": null
    }
}