OpenAPITools / OpenAPITools/openapi-diff
Markdown output does not specify whether the change is backward-compatible or not
Open
Nobody has claimed this yet.
Breaking/Non-Breaking classification
Render capabilities
- Dominant language
- Java
- Stars
- 1.1k
- Forks
- 190
- PR merge metrics
- No merged PRs in 30d
Description
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
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with the Markdown output example in the project README and compare it with the HTML and default CLI output mentioned in the issue. Trace the Markdown report generation from there; done when the Markdown output specifies whether each change is backward-compatible, consistently with the other formats.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- java
- Domain
- api
- Issue type
- Bug
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 48/100