openapi-diff
openapi-diff copied to clipboard
Utility for comparing two OpenAPI specifications.
When using AllOf for polymorphism, when a property references a parent schema using ref and a change is done to a child schema which is not referenced directly anywhere in...
I wrote this on #215 day before yesterday: > ... the [json] file size was over 10,000x that of the html and md files. No joke: the same diff produced...
1. string to object (actual: compatible, expected: incompatible) 2. string to integer/integer to string (actual: no_change, expected: incompatible) Case 1: old.yml ```yaml openapi: 3.1.0 info: title: Demo API version: v1...
Compared 2 API Specifications json. The Specification contains multiple component schemas. But if there is an Enum Array (same array) is present in different component schemas, then while publishing the...
I have a task in which I have to check if out spec is updated. But I want to compare not only if the specs are compatible, I want to...
From help, ``` --state Only output diff state: no_changes, incompatible, compatible ``` this doesn't align with reality. We had a case where the state outputted metadata. Caused by this line:...
When using openapi-diff-cli we need to give and filenames. It will be cool to have those filenames in the report output. Before: ``` ========================================================================== == API CHANGE LOG == ==========================================================================...
When comparing these 2 schemas: `test/old.json` ```json { "openapi": "3.0.0", "servers": [{ "url": "https://myserver.com" }], "info": { "title": "My API", "description": "Description", "version": "0.2.0" }, "paths": { "/v1/entity/{id}": { "put":...
If i try to diff two files where only the following is different, i get the following error Compare 1: `{ "name": "oneLine", "description": "***", "required": false, "in": "query", "type":...
While testing out this tool, we've noticed that `increasing the maxLength` property for a String field would return `API changes broke backward compatibility` while `decreasing the maxLength property` for a...