[Rendering] R1: lean JSON output and --state fix

Offen
#957 0 Kommentare 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen

Maintainer antworten meist innerhalb von 5 Tagen

Dieses Issue hat noch niemand übernommen.

Bewertung

Schwierigkeit
3/5
Geschätzter Aufwand
1-2 Tage
Anfängerfreundlichkeit
55/100
Issue-Typ
Feature
Klarheit
Größtenteils klar
Aktivitätsstatus
Aktiv
Tech-Stack
java, json, openapi
Bereich
cli

Rechercherichtung

Start by locating the CLI JSON rendering path and the --state flag handling; read the linked rendering plan #954 and #562 for the expected output shape. Add the new formatVersion/result/summary/changes output and its JSON Schema, then add tests that validate output against the schema and assert --state never emits metadata. Done means those tests pass and the large spec pair produces small output.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Beschreibung

Render capabilities

Part of the rendering plan: #954 (R1)

Goal

--json outputs the change list instead of the whole result tree.

Scope
  • New JSON output: formatVersion, result, summary, changes (#562)
  • JSON Schema for it in the repo, with the rule "consumers must ignore unknown fields"
  • --state prints only no_changes, compatible or incompatible, as documented (#508)
Done when
  • JSON output validates against the JSON Schema in tests
  • The spec pair from #562 (or a similar large one) produces small output
  • --state never prints metadata
Vorherrschende Sprache
Java
Sterne
1.1k
Forks
191
Ø Merge
4 T. 23 Std.
Gemergte PRs (30 T.)
1

Entwicklungsumgebung

Erste Schritte

  1. Lesen Sie das ganze Issue und danach den Beitragsleitfaden des Projekts.
  2. Schreiben Sie ins Issue, dass Sie es übernehmen — das erspart doppelte Arbeit.
  3. Forken Sie das Repository und arbeiten Sie in einem Branch.
  4. Öffnen Sie einen Pull Request, der die Issue-Nummer nennt.

Mehr aus OpenAPITools/openapi-diff

Alle Issues in OpenAPITools/openapi-diff

Ähnliche Issues

Weitere Issues zu Java

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.