[Rendering] R0: change list and builder

Offen
#956 1 Kommentar 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen

Maintainer antworten meist innerhalb von 5 Tagen

@Inf1mum arbeitet bereits daran.

Seit 16.11.2026.

  • #962 von @Inf1mum — offen

Bewertung

Schwierigkeit
4/5
Geschätzter Aufwand
3-5 Tage
Anfängerfreundlichkeit
32/100
Issue-Typ
Feature
Klarheit
Größtenteils klar
Aktivitätsstatus
Aktiv
Tech-Stack
java
Bereich
api, tooling

Rechercherichtung

Start from the rendering plan in #954 and the existing ChangedSchema type, then confirm where the engine already computes the old/new $ref so it can be stored. The generic walk hangs off getChangedElements(), so read that tree traversal first, then look at the existing result tests to see what "today's result" means for the completeness check. Done is a ChangeReport builder reproducing current results across the whole test suite, with records also covering #839, #872, #802, #893 and #857. Note this issue bundles four PR-sized items, so it is likely split before anyone starts.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Beschreibung

Render capabilities

Part of the rendering plan: #954 (R0)

Goal

Turn the result tree into a flat list of change records once. Nothing uses it yet.

Scope

One item per PR:

  • Store the old/new $ref on ChangedSchema (the engine knows it, but doesn't keep it today)
  • Change record (rule, result, operation, location, component, pointer, change, old, new, message) and ChangeReport (model only)
  • Builder: generic walk over getChangedElements(), plus operation-level changes (parameters, request/response bodies, responses, headers, security, extensions, examples, operation metadata)
  • Builder: schema changes (properties, enum, type, bounds, required, readOnly/writeOnly, …)

Verdicts are copied from the result tree; no rule changes. rule and result are owned by #724.

Done when
  • Completeness test: every node in the result tree whose own result isn't NO_CHANGES produces at least one record
  • Changes from the related issues produce records: extensions (#839), examples (#872), security scheme fields (#802, #893), operation description (#857)
  • Overall result from the change list = today's result for all existing tests
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.