OpenAPITools / OpenAPITools/openapi-diff
Markdown output does not contain compatibility information
Open
Nobody has claimed this yet.
- Dominant language
- Java
- Stars
- 1.1k
- Forks
- 190
- PR merge metrics
- No merged PRs in 30d
Description
First of all, thanks for your great work on openapi-diff!
Markdown output does not contain information about the compatibility of a change. However, the HTML output contains the necessary compatibility information.
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 by locating the Markdown and HTML output generation in openapi-diff and reproduce the discrepancy with two OpenAPI specifications whose changes have compatibility information. Compare the two renderers; done when Markdown reports the same compatibility information that already appears in the HTML output.
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
- 45/100