Markdown output does not contain compatibility information

Open
#325 2 comments 12 reactions 0 assignees View on GitHub

Maintainers usually reply within 5 days

Nobody has claimed this yet.

Assessment

Difficulty
3/5
Estimated time
1-2 days
Newbie friendliness
45/100
Issue type
Bug
Clarity
Mostly clear
Activity status
Stale
Tech stack
java
Domain
api

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.

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.

Dominant language
Java
Stars
1.1k
Forks
191
Avg merge
4d 23h
Merged PRs (30d)
1

Getting set up

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from OpenAPITools/openapi-diff

All issues in OpenAPITools/openapi-diff

Similar issues

More Java issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.