[Rendering] R0: change list and builder

未关闭
#956 1 条评论 0 个 reaction 已指派 0 人 在 GitHub 查看

维护者通常 5 天内回复

@Inf1mum 已经在做这个了。

开始于 2026年11月16日。

  • #962 来自 @Inf1mum —— 未关闭

评估

难度
4/5
预计耗时
3-5 天
新手友好度
32/100
Issue 类型
功能
描述清晰度
基本清楚
活跃度
活跃
技术栈
java
领域
api, tooling

调研方向

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.

由索引模型根据 Issue 内容生成。

描述

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
主要语言
Java
星标
1.1k
派生
191
平均合并
4 天 23 小时
30 天内合并 PR
1

环境准备

  • 提供 Dockerfile 或 Docker Compose 文件
  • 没有 Pull Request 模板
  • 阅读贡献指南

从这里开始

  1. 先读完整个 Issue,再读项目的贡献指南。
  2. 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
  3. Fork 仓库,在一个分支上完成修改。
  4. 提交 Pull Request,并在描述里引用这个 Issue 编号。

OpenAPITools/openapi-diff 的其他 Issue

查看 OpenAPITools/openapi-diff 的全部 Issue

相似的 Issue

更多 Java Issue

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。