openapi-diff icon indicating copy to clipboard operation
openapi-diff copied to clipboard

Utility for comparing two OpenAPI specifications.

Results 131 openapi-diff issues
Sort by recently updated
recently updated
newest added

Guys, I have a problem when generating a changelog in HTML format, it is not showing me the parameters that changed, however, in md it is showing the changes correctly....

Old API ``` { "openapi":"3.0.0", "info":{ "title":"API", "version":"0.1.0" }, "paths":{ "/resource":{ "post":{ "responses":{ "200":{ "description":"Created resource", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/CreateResourceResponse" } } } } }, "summary":"Create resource", "requestBody":{ "content":{ "application/json":{...

It would be very nice, to add a templating support like with the "openapi-generator" to implement very fast a new output format. - Handlebars / Moustache prefered :-)

enhancement
help wanted

* When endpoint pathParams change and Parameter names are changed to be similar to pathParams - Don't remove parameters from the path - This allows the `ChangedParameter class` to not...

### Old Schema ``` paths: /student/{id}: get: parameters: - in: path name: id # Note the name is the same as in the path required: true schema: type: string pattern:...

**The bug** When splitting a schema into two schemas where one refers with allOf to the other the diff shows breaking change, even if the end structure is the same....

help wanted
Breaking/Non-Breaking classification

So I've been tested _openapi-diff_ to see if we can use it in our CI/CD pipeline to prevent any breaking changes from happening. After running a few tests I've noticed...

bug

Markdown output got all changes, but Html is missing new optional properties / descriptions

i changed the format of a string property. e.g. when generated out of java and the propery is now mapped via Spring from a String to a UUID. Perhaps it's...