Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
reuvenharrison authored Oct 28, 2024
1 parent 2d2eea3 commit a8591cc
Showing 1 changed file with 4 additions and 1 deletion.
5 changes: 4 additions & 1 deletion docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -90,7 +90,10 @@ docker run --rm -t tufin/oasdiff changelog https://raw.githubusercontent.com/Tuf
- checks: displays the different checks that oasdiff runs to detect changes

## Roadmap
[Help us define the roadmap](https://github.com/Tufin/oasdiff/discussions/631)
I am currently working on the ability to correlate breaking changes and changelog messages with the underlying changes in the original YAML spec.
This will allow users to see changes in their original context, investigate, and determine how to handle them.
Specifically, github users will be able to click annotations and see the diff at the relevant line as discussed [here](https://github.com/Tufin/oasdiff/issues/574).
[Please help us prioritize the roadmap](https://github.com/Tufin/oasdiff/discussions/631).

## Credits
This project relies on the excellent implementation of OpenAPI 3.0 for Go: [kin-openapi](https://github.com/getkin/kin-openapi).
Expand Down

0 comments on commit a8591cc

Please sign in to comment.