Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Markdown output does not specify whether the change is backward-compatible or not #766

Open
tuananhlai opened this issue Apr 5, 2025 · 1 comment
Labels
Breaking/Non-Breaking classification Issues related to Breaking/Non-Breaking changes classification Render capabilities Issue related to output rendering

Comments

@tuananhlai
Copy link

From testing the tools and looking at the example Markdown output in the project README, it seems like this output doesn't specify whether a change is backward compatible or not, unlike HTML or the default CLI output.

https://github.com/OpenAPITools/openapi-diff?tab=readme-ov-file#markdown-1

@DrSatyr DrSatyr added Breaking/Non-Breaking classification Issues related to Breaking/Non-Breaking changes classification Render capabilities Issue related to output rendering labels Apr 5, 2025
@DrSatyr
Copy link
Collaborator

DrSatyr commented Apr 5, 2025

Thank you for raising this question, @tuananhlai

Currently, the library supports various rendering methods, but the amount of data presented during rendering is not guaranteed to be uniform.

So, it can be a good point for refactoring and unification. We need somebody to lead this initiative.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Breaking/Non-Breaking classification Issues related to Breaking/Non-Breaking changes classification Render capabilities Issue related to output rendering
Projects
None yet
Development

No branches or pull requests

2 participants