[Rendering] R3: new Render API and migration notes

Aberta
#959 0 comentários 0 reações 0 responsáveis Ver no GitHub

Mantenedores costumam responder em até 5 dias

Ninguém assumiu esta issue ainda.

Avaliação

Dificuldade
5/5
Tempo estimado
Mais de uma semana
Facilidade para iniciantes
20/100
Tipo de issue
Refatoração
Clareza
Razoavelmente clara
Status de atividade
Ativa
Stack de tecnologia
java
Domínio
tooling

Direção de pesquisa

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.

Escrita pelo modelo de indexação a partir do texto da issue.

Descrição

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
Linguagem predominante
Java
Estrelas
1.1k
Forks
191
Merge médio
4d 23h
PRs com merge (30d)
1

Preparar o ambiente

Primeiros passos

  1. Leia a issue inteira e depois o guia de contribuição do projeto.
  2. Comente na issue dizendo que vai assumir — evita que duas pessoas façam o mesmo trabalho.
  3. Faça um fork do repositório e trabalhe em uma branch.
  4. Abra um pull request que referencie o número da issue.

Mais de OpenAPITools/openapi-diff

Todas as issues de OpenAPITools/openapi-diff

Issues semelhantes

Mais issues de Java

Receba novas issues na sua caixa de entrada

Um resumo curto de issues do GitHub para quem está começando.