OpenAPITools / OpenAPITools/openapi-diff
ExtensionDiff in renderers (just tried console and html)
Nobody has claimed this yet.
- Dominant language
- Java
- Stars
- 1.1k
- Forks
- 190
- PR merge metrics
- No merged PRs in 30d
Description
I'm implementing ExtensionDiffs, but it seems they don't make it into the renderers, or at least I don't see how they would.
I.e. I'm only using console and html.
The console renderer just lists the route as changed and says there were backward incompatible changes in the spec but no further detail.
The html renderer lists the route under "What's Changed" with an empty <ul> with class detail which then renders as a thick gray line.
It would be nice if the renderers would be able to display details about the extension differences, especially when they are breaking, but also the non-breaking ones would be interesting.
In the html renderer result there is not even an indication whether there were breaking changes or not if the breaking changes come from an extension diff.
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 tracing ExtensionDiff from the comparison output into the console and HTML renderers, focusing on the existing route-change and detail-list rendering. Done means both renderers show extension-difference details and indicate whether those differences are breaking or non-breaking.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- java
- Domain
- api
- Issue type
- Feature
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100