[Rendering] R3: new Render API and migration notes

Open
#959 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
20/100
Issue type
Refactor
Clarity
Mostly clear
Activity status
Active
Tech stack
java
Domain
tooling

Research direction

Read the rendering plan in #954 first, then find the current Render entry point and the renderer classes that take ChangedOpenApi/Changed* so you know what is being removed. The migration notes and README output examples depend on the final Render.render(ChangeReport, Writer) signature and the --json, --html-detailed, --template and stderr-logging behaviour, so settle the API before writing docs. Done means no renderer references Changed* classes and the README plus migration notes match the new CLI output.

Written by the indexing model from the issue text.

Description

Render capabilities

Part of the rendering plan: #954 (R3)

Goal

The stable 3.0.0 rendering API; old renderer code is removed.

Scope
  • Render.render(ChangeReport, Writer); the caller owns and closes the writer
  • Remove the old renderer code and the deprecated String render(ChangedOpenApi)
  • Migration notes: Render API, --json format, --html-detailed, --template, logs on stderr
  • README: output examples for every format and a template example
Done when
  • No renderer reads Changed* classes or spec objects
  • Migration notes and README updated
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.