OpenAPITools/openapi-diff

Template-based output

Open

#355 geöffnet am 15. März 2022

Auf GitHub ansehen
 (0 Kommentare) (1 Reaktion) (0 zugewiesene Personen)Java (1.079 Stars) (187 Forks)user submission
enhancementhelp wanted

Beschreibung

It would be very nice, to add a templating support like with the "openapi-generator" to implement very fast a new output format.

  • Handlebars / Moustache prefered :-)

Contributor Guide

Tech Stack
java
Domain
clitooling
Issue Type
feature
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
3
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
1-2 days
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
stale
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
clear
Voraussetzungen
Basic Java knowledgeFamiliarity with templating engines
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
40
Research-Richtung
Investigate the current output mechanism in the OpenAPI Diff codebase, likely in a class like 'DiffOutput' or similar. Look at how openapi generator implements template based output using Handlebars/Mustache. Propose a design that integrates a templating engine to allow users to customize the diff output format. Consider adding a command line option to specify a template file. Review any existing discussions or PRs linked to this issue.