[Rendering] R2: views, templates and built-in formats

Ouverte
#958 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
18/100
Type d'issue
Fonctionnalité
Clarté
Plutôt claire
Activité
Active
Stack technique
handlebars, html, java, markdown
Domaine
cli, tooling

Piste de recherche

This is the R2 umbrella of the rendering plan in #954 and is split into one PR per checkbox, so start by reading the existing renderer and view classes under the core rendering package, plus how --html and --html-detailed map to files today. Pick a single unchecked item (the Markdown built-in template is the most self-contained) and read the cross-format test it must satisfy. Done means that format shows every record, every change shows its result, and each record appears exactly once in the cross-format test.

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

Description

Render capabilities

Part of the rendering plan: #954 (R2)

Goal

All text formats render from the change list: Markdown, HTML and Asciidoc as built-in templates, Console in Java.

Scope

One item per PR:

  • byOperation() view: operation → common location prefix, group result = worst result
  • byComponent() view: model → common component.path prefix, each change with its operations (API only in 3.0.0)
  • Template support: Handlebars.java, template data, --template (output to stdout), --print-template, log messages to stderr, Maven templateFile + templateOutputFileName (#355)
  • Markdown as a built-in template (plain Mustache syntax) + cross-format test
  • HTML as a built-in template; both flags stay: --html shows only breaking changes, --html-detailed shows all changes, as today
  • Asciidoc as a built-in template
  • Console moved to the byOperation() view

Header in every text format: spec titles, file names (#506), overall result, totals per result (#627).

Done when
  • Cross-format test: every format shows every record (#620, #215, #362)
  • Every change shows its result in every format (#766, #325)
  • A shared schema change is shown under every operation that uses it (#523)
  • Each view shows every record exactly once
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.