Schema description update should be considered as a metadata change
まだ誰も着手していません。
評価
調査の方向性
提供された OpenAPI diff を再現し、その後、参照されている 160 行目付近の core/src/main/java/org/openapitools/openapidiff/core/model/ChangedSchema.java を、ChangedMetadata.java および ChangedSchema.java のメタデータ処理と併せて調査する。スキーマの説明のみの変更が、単に後方互換と報告されるのではなく、メタデータの変更として報告されれば完了とする。
索引モデルが issue の本文から書いたものです。
説明
Hello,
When diffing this spec:
openapi: 3.0.3
info:
title: Test
paths:
/foo:
post:
requestBody:
content:
application/json:
schema:
type: string
description: desc v1
with this one:
openapi: 3.0.3
info:
title: Test
paths:
/foo:
post:
requestBody:
content:
application/json:
schema:
type: string
description: desc v2
I get the following output:
==========================================================================
== API CHANGE LOG ==
==========================================================================
Test
--------------------------------------------------------------------------
-- What's Changed --
--------------------------------------------------------------------------
- POST /foo
Request:
- Changed application/json
Schema: Backward compatible
--------------------------------------------------------------------------
-- Result --
--------------------------------------------------------------------------
API changes are backward compatible
--------------------------------------------------------------------------
Since only the description field changed, I would expect a "metadata" change instead of a "compatible" one.
Changes to the description are correctly marked as metadata ones internally (see here and here) but I suspect the final value that is picked up to be the default one returned here. I don't have the time or means to debug it further however.
Tested version: 2.1.0-beta.11
- 主要言語
- Java
- スター
- 1.1k
- フォーク
- 190
- PR マージ指標
- 30日以内にマージされた PR はありません
コントリビューションガイド
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
OpenAPITools/openapi-diff のほかの issue
-
enhancement
難易度 2/5 1〜3時間 初心者へのやさしさ 68/100
OpenAPITools/openapi-diff#506 ·
-
good first issue help wanted
難易度 2/5 1〜3時間 初心者へのやさしさ 68/100
OpenAPITools/openapi-diff#364 ·
-
bug OpenAP 3.1.0 Support
難易度 3/5 1〜2日 初心者へのやさしさ 68/100
OpenAPITools/openapi-diff#910 · コメント 1 件 ·
-
Render capabilities
難易度 3/5 1〜2日 初心者へのやさしさ 55/100
OpenAPITools/openapi-diff#893 · コメント 1 件 ·
-
Breaking/Non-Breaking classification
難易度 3/5 1〜2日 初心者へのやさしさ 55/100
OpenAPITools/openapi-diff#886 ·
OpenAPITools/openapi-diff の issue をすべて見る
似ている issue
-
難易度 2/5 1〜3時間 初心者へのやさしさ 65/100
-
bug
難易度 2/5 1〜3時間 初心者へのやさしさ 75/100
-
難易度 2/5 1〜3時間 初心者へのやさしさ 75/100
elastic/gradle-plugins#157 ·
-
難易度 2/5 1〜3時間 初心者へのやさしさ 75/100
cryptomator/hub#497 ·
-
難易度 2/5 1〜3時間 初心者へのやさしさ 75/100
johanhaleby/occurrent#1120 ·