[Rendering] R0: change list and builder

Aberta
#956 1 comentário 0 reações 0 responsáveis Ver no GitHub

Mantenedores costumam responder em até 5 dias

@Inf1mum já está trabalhando nisso.

Desde 16/11/2026.

  • #962 de @Inf1mum — aberto

Avaliação

Dificuldade
4/5
Tempo estimado
3-5 dias
Facilidade para iniciantes
32/100
Tipo de issue
Funcionalidade
Clareza
Razoavelmente clara
Status de atividade
Ativa
Stack de tecnologia
java
Domínio
api, tooling

Direção de pesquisa

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.

Escrita pelo modelo de indexação a partir do texto da issue.

Descrição

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
Linguagem predominante
Java
Estrelas
1.1k
Forks
191
Merge médio
4d 23h
PRs com merge (30d)
1

Preparar o ambiente

Primeiros passos

  1. Leia a issue inteira e depois o guia de contribuição do projeto.
  2. Comente na issue dizendo que vai assumir — evita que duas pessoas façam o mesmo trabalho.
  3. Faça um fork do repositório e trabalhe em uma branch.
  4. Abra um pull request que referencie o número da issue.

Mais de OpenAPITools/openapi-diff

Todas as issues de OpenAPITools/openapi-diff

Issues semelhantes

Mais issues de Java

Receba novas issues na sua caixa de entrada

Um resumo curto de issues do GitHub para quem está começando.