[Rendering] R0: change list and builder

Open
#956 1 comment 0 reactions 0 assignees View on GitHub

Maintainers usually reply within 5 days

@Inf1mum is already working on this.

Since Nov 16, 2026.

  • #962 by @Inf1mum — open

Assessment

Difficulty
4/5
Estimated time
3-5 days
Newbie friendliness
32/100
Issue type
Feature
Clarity
Mostly clear
Activity status
Active
Tech stack
java
Domain
api, tooling

Research direction

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.

Written by the indexing model from the issue text.

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
Dominant language
Java
Stars
1.1k
Forks
191
Avg merge
4d 23h
Merged PRs (30d)
1

Getting set up

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from OpenAPITools/openapi-diff

All issues in OpenAPITools/openapi-diff

Similar issues

More Java issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.