[Rendering] R3: new Render API and migration notes

Ouverte
#959 0 commentaires 0 réactions 0 personnes assignées Voir sur GitHub

Les mainteneurs répondent en général sous 5 jours

Personne n'a encore pris cette issue.

Évaluation

Difficulté
5/5
Temps estimé
Plus d'une semaine
Accessibilité débutants
20/100
Type d'issue
Refactorisation
Clarté
Plutôt claire
Activité
Active
Stack technique
java
Domaine
tooling

Piste de recherche

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.

Rédigé par le modèle d'indexation à partir du texte de l'issue.

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
Langage dominant
Java
Étoiles
1.1k
Forks
191
Merge moyen
4 j 23 h
PR mergées (30 j)
1

Préparer son environnement

Par où commencer

  1. Lisez l'issue en entier, puis le guide de contribution du projet.
  2. Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
  3. Forkez le dépôt et travaillez sur une branche.
  4. Ouvrez une pull request qui référence le numéro de l'issue.

Autres issues de OpenAPITools/openapi-diff

Toutes les issues de OpenAPITools/openapi-diff

Issues similaires

Plus d'issues Java

Recevez les nouvelles issues par e-mail

Un résumé court des issues GitHub adaptées aux débutants.