[Rendering] 3.0.0: one change list for all output formats

Open
#955 0 comments 0 reactions 0 assignees View on GitHub

Maintainers usually reply within 5 days

Nobody has claimed this yet.

Assessment

Difficulty
5/5
Estimated time
Over a week
Newbie friendliness
12/100
Issue type
Feature
Clarity
Mostly clear
Activity status
Active
Tech stack
java
Domain
content

Research direction

This is an umbrella tracking issue, not a single task: read the parent plan #954 and the phase sub-issues (R0–R3) it links before touching code. Pick one unclaimed phase sub-issue and work from its own description; done for this issue means every phase sub-issue is closed and the rendering section of the 3.0.0 migration notes is written. Do not start a patch against this issue directly.

Written by the indexing model from the issue text.

Description

Render capabilities

Tracking issue for the rendering plan: #954

Goal

New output foundation in 3.0.0:

  • every detected change is shown in every format, with its verdict and rule
  • lean, documented JSON output
  • Markdown, HTML and Asciidoc as templates; users can use their own template
  • a stable rendering API, so 3.x needs no breaking changes
Phases

Tracked as sub-issues of this issue (R0–R3).

Done when
  • All phase sub-issues are closed
  • Rendering part of the 3.0.0 migration notes is complete
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.