OpenAPITools / OpenAPITools/openapi-diff
Operation description change is detected as a change but it is not rendered by HtmlRender
Nobody has claimed this yet.
- Dominant language
- Java
- Stars
- 1.1k
- Forks
- 190
- PR merge metrics
- No merged PRs in 30d
Description
When the operation's description changes it is not rendered in the Html
In the following specifications the only difference when compared in text edit are their version and the operation's description
sample-api_3.47.0_ALL.json
sample-api_3.48.0_ALL.json
The operation is detected as changed but renders nothing
Report was generated by using the example code in home page by specifying rendering all changes i.e.
HtmlRender htmlRender = new HtmlRender("Changelog", "http://deepoove.com/swagger-diff/stylesheets/demo.css", true);
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 HtmlRender example configuration and compare its output in testDiff.html for sample-api_3.47.0_ALL.json and sample-api_3.48.0_ALL.json. Trace how the changed operation description is processed and rendered; done means the generated HTML visibly includes the description change when all changes are rendered.
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