[Rendering] R0: change list and builder

Ouverte
#956 1 commentaire 0 réactions 0 personnes assignées Voir sur GitHub

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

@Inf1mum y travaille déjà.

Depuis le 16/11/2026.

  • #962 par @Inf1mum — ouverte

Évaluation

Difficulté
4/5
Temps estimé
3-5 jours
Accessibilité débutants
32/100
Type d'issue
Fonctionnalité
Clarté
Plutôt claire
Activité
Active
Stack technique
java
Domaine
api, tooling

Piste de recherche

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.

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

Description

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
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.