OpenAPITools / OpenAPITools/openapi-diff

Renderers should display example changes, not just schema changes

オープン
#872 コメント 0 件 リアクション 0 件 担当者 0 名 GitHub で見る

まだ誰も着手していません。

Render capabilities
主要言語
Java
スター
1.1k
フォーク
190
PR マージ指標
30日以内にマージされた PR はありません

説明

When a ChangedMediaType has example changes but no schema changes, the renderers (Console, Markdown, Asciidoc, HTML) currently show nothing in the details section because they only render schema changes. The ChangedMediaType model has example and examples fields that could be rendered alongside schema changes.

This was discovered while fixing https://github.com/OpenAPITools/openapi-diff/issues/870 where the NPE was caused by null schema when only examples changed.

コントリビューションガイド

コントリビューションガイドを開く

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

調査の方向性

まず、ChangedMediaType モデルと、Console、Markdown、Asciidoc、HTML レンダラーのエントリーポイントを見つけます。スキーマの変更が details セクションにどのように追加されるかを追跡し、スキーマの変更が存在しない場合でも example と examples の変更が処理されることを確認します。4 つすべてのレンダラーの details 出力を確認し、既存のリグレッションテストを確認します。

索引モデルが issue の本文から書いたものです。

評価

技術スタック
java
領域
api
issue の種類
バグ
難易度
3/5
見積もり時間
1〜2日
活発さ
停滞
明瞭さ
おおむね明確
初心者へのやさしさ
48/100

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。