Comments (7)
This is in progress as part of a new changelog feature.
You are welcome to join the discussion: #229
from oasdiff.
@reuvenharrison , I tried "changelog" feature with version 2.1.2. But it seems that it still returns only breaking changes with default parameters. I can see much more changes mentioned in "diff" report than in "changelog" report. Am I missing something?
from oasdiff.
oasdiff changelog
returns 3 levels of changes: ERR, WARN and INFO.
The INFO-level changes are the non-breaking ones.
There is on-going work by multiple contributors to reach full coverage so that the changelog will cover all changes.
For example:
(base) ➜ oasdiff git:(main) oasdiff changelog data/openapi-test1.yaml data/openapi-test3.yaml
16 changes: 2 error, 4 warning, 10 info
error [response-success-status-removed] at data/openapi-test3.yaml
in API GET /api/{domain}/{project}/badges/security-score
removed the success response with the status '200'
error [response-success-status-removed] at data/openapi-test3.yaml
in API GET /api/{domain}/{project}/badges/security-score
removed the success response with the status '201'
warning [request-parameter-removed] at data/openapi-test3.yaml
in API GET /api/{domain}/{project}/badges/security-score
deleted the 'cookie' request parameter 'test'
warning [request-parameter-removed] at data/openapi-test3.yaml
in API GET /api/{domain}/{project}/badges/security-score
deleted the 'header' request parameter 'user'
warning [request-parameter-removed] at data/openapi-test3.yaml
in API GET /api/{domain}/{project}/badges/security-score
deleted the 'query' request parameter 'filter'
warning [request-parameter-removed] at data/openapi-test3.yaml
in API GET /api/{domain}/{project}/install-command
deleted the 'header' request parameter 'network-policies'
info [api-global-security-removed]
in security
the security scheme 'bearerAuth' was removed from the API
info [api-schema-removed]
in components
removed the schema 'network-policies'
info [api-schema-removed]
in components
removed the schema 'rules'
info [api-security-component-removed]
in components
the component security scheme 'AccessToken' was removed
info [api-security-component-removed]
in components
the component security scheme 'bearerAuth' was removed
info [api-operation-id-removed] at data/openapi-test1.yaml
in API GET /api/{domain}/{project}/badges/security-score
api operation id 'GetSecurityScores' removed and replaced with 'GetSecurityScore'
info [api-tag-removed] at data/openapi-test1.yaml
in API GET /api/{domain}/{project}/badges/security-score
api tag 'security' removed
info [response-non-success-status-removed] at data/openapi-test3.yaml
in API GET /api/{domain}/{project}/badges/security-score
removed the non-success response with the status '400'
info [api-security-removed] at data/openapi-test3.yaml
in API POST /register
the endpoint scheme security 'bearerAuth' was removed from the API
info [api-security-scope-added] at data/openapi-test3.yaml
in API POST /register
the security scope 'write:pets' was added to the endpoint's security scheme 'OAuth'
from oasdiff.
@reuvenharrison , thanks for update, so I am considering this feature as incomplete and looking forward for updates.
If you have any interest, I am building a simple HTML visualizer (based on JS Tabulator library) for changelog in JSON format.
Would be happy to share if you are interested.
from oasdiff.
I think your tool may be valuable to oasdiff users :-)
Please share a link and I will also add a reference to it in the readme.
from oasdiff.
oasdiff changelog
currently supports 129 non-breaking checks.
You can see the full list by running oasdiff checks --severity info
.
The community is invited to add more checks as needed.
I am closing this as completed.
from oasdiff.
I think your tool may be valuable to oasdiff users :-) Please share a link and I will also add a reference to it in the readme.
@reuvenharrison , I owed you this one.
This is a ZIP archive with two files: HTML and JS. You can just open HTML locally in the browser to see how it looks like.
JS file is actually produced from JSON output of oasdiff changelog with some extra fields (I compose it using bash script from real oasdiff output and some variables indicating GitLab revisions).
The UI is based on fantastic Tabulator library (https://tabulator.info/).
Feel free to use in your projects if you find it useful.
from oasdiff.
Related Issues (20)
- Race condition while parsing command line arguments if telemetry is enabled HOT 1
- "Error resolving reference/map key not found" when running oasdiff across the set of files with intensive external refs HOT 2
- Supporting "--fail-on" option for changelog command
- basePath and servers.ulr support HOT 3
- Add support for AWS API Gateway extensions to OpenAPI HOT 6
- Diff tool gets confused when a new inline enum value is added and a new enum type is added at the sime time HOT 4
- Changelog does not log adding a new optional request body HOT 2
- `latest` docker container (April 8th) introduces a bug that causes false positives HOT 1
- --flatten-allof panic HOT 3
- Unmarshalling errors don't provide offset HOT 6
- Support breaking-changes and changelog for schemas with multiple types
- Support "flatten allOf" for schemas with multiple types
- Typo in description of incompatible changes HOT 2
- Incorrect Detection of Breaking Change for Default Values
- Adding deprecated: true to an operation yields a parse error HOT 5
- Handle default values properly
- Checksums do not match while using install script. HOT 8
- No breaking change reported in referenced query parameter HOT 1
- Provide source code lines when reporting breaking changes HOT 4
- Improve breaking checks accuracy
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
D3
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
-
Recommend Topics
-
javascript
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
-
web
Some thing interesting about web. New door for the world.
-
server
A server is a program made to process requests and deliver data to clients.
-
Machine learning
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from oasdiff.