Consider removal of deprecated elements as compatible

オープン

#371 2022年5月5日に作成コメント 4 件リアクション 0 件担当者 0 名 GitHub で見る

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

評価

難易度: 5/5
見積もり時間: 1週間以上
初心者へのやさしさ: 20/100

issue の種類: 機能追加
明瞭さ: 説明が足りない
活発さ: 停滞
技術スタック: java
領域: api

調査の方向性

まず ChangedOpenApi#getChangedElements と、openapi-diff が現在削除を非互換として分類する方法を調査します。アプローチを決定する前に、既存の拡張ポイントと issue で提案されている SPI のアイデアを確認します。Done では、既存の breaking-change チェックを維持しながら、非推奨要素の削除を互換として扱う明確な方法を提供する必要があります。

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

説明

Breaking/Non-Breaking classification

I'm using openapi-diff quite successfully to avoid accidental changes in the API (and therefore introducing a breaking change). We use it as a part of our pipeline.

The current struggle is: that sometimes one wants to introduce a breaking change (like the removal of obsolete API).
My initial idea would float around a two-step process:

marking an element ad deprecated (keeping compatibility)
removing the deprecated element

To do that, when processing the list of ChangedOpenApi#getChangedElements I'd need to know if the particular element is deprecatable and decide if the change is incompatible or not.

That looks to me like another SPI but I'm not sure if it's the direction. I know it's currently not possible and I'm not even sure if the direction of my thought even makes sense.

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

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

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

はじめの一歩

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

OpenAPITools/openapi-diff のほかの issue

In openapi-diff-cli add old and new filenames to the output オープン

enhancement

難易度 2/5 1〜3時間初心者へのやさしさ 68/100

OpenAPITools/openapi-diff#506 · 2023年4月4日に作成
HtmlRender: Notes of Parameters shows always the new description オープン

good first issue help wanted

難易度 2/5 1〜3時間初心者へのやさしさ 68/100

OpenAPITools/openapi-diff#364 · 2022年4月5日に作成
Property `type` change on referenced component schema is silently ignored オープン

bug OpenAP 3.1.0 Support

難易度 3/5 1〜2日初心者へのやさしさ 68/100

OpenAPITools/openapi-diff#910 · コメント 1 件 · 2026年6月12日に作成
Changes reported in operations but only securityScheme changed オープン

Render capabilities

難易度 3/5 1〜2日初心者へのやさしさ 55/100

OpenAPITools/openapi-diff#893 · コメント 1 件 · 2026年2月25日に作成
[Bug] Backward compatibility check fails on reordered discriminator mappings オープン

Breaking/Non-Breaking classification

難易度 3/5 1〜2日初心者へのやさしさ 55/100

OpenAPITools/openapi-diff#886 · 2026年1月30日に作成

OpenAPITools/openapi-diff の issue をすべて見る

似ている issue

[Bug]: JavaScript dialog is complaining about changes when there were none オープン

awaiting triage bug Causes friction Hop Gui P1 P2 Transforms

難易度 2/5 1〜3時間初心者へのやさしさ 75/100

apache/hop#8564 · 2026年9月23日に作成
[Bug][api] MemoryRef equality ignores the memory type オープン

難易度 2/5 1〜3時間初心者へのやさしさ 75/100

apache/flink-agents#1152 · 2026年9月23日に作成
Gauntlet loot not showing up in boss section オープン

難易度 2/5 1〜3時間初心者へのやさしさ 75/100

TheStonedTurtle/Loot-Logger#97 · 2026年9月23日に作成
TryBlueOceanMenu allocates a per-FlowNode URL object trio, retaining ~21 GiB on large pipeline graphs オープン

難易度 2/5 1〜3時間初心者へのやさしさ 70/100

jenkinsci/blueocean-plugin#5417 · 2026年9月23日に作成
Dijkstra entry point crashes with ArrayIndexOutOfBoundsException when a vertex id exceeds the argument count オープン

難易度 2/5 1〜3時間初心者へのやさしさ 75/100

objectionary/eo-graphs#75 · 2026年9月23日に作成

Java の issue をもっと見る