OpenAPITools / OpenAPITools/openapi-diff
Mark down changelog generation - enum rename interpreted as added
オープン
まだ誰も着手していません。
- 主要言語
- Java
- スター
- 1.1k
- フォーク
- 190
- PR マージ指標
- 30日以内にマージされた PR はありません
説明
I tested that on version 2.1.2 and 2.1.3. This unusual case but happened.
The following is modified excerpt of the json files. One of the enum field has bee renamed from 'StatusThree' to 'StatusNew'.
Then the change log has been generated in mark down format. The ideal case would be markdown reporting field renamed from A to B. The second best would be. A removed. B added. However markdown report states only the fact that B has been added.
Old Version:
{
"definitions": {
"SomeStatus": {
"description": "Some status description",
"enum": [
"StatusOne",
"StatusTwo",
"StatusThree"
],
"type": "string",
"x-ms-enum": {
"name": "SomeStatus",
"modelAsString": false,
"values": [
{
"name": "StatusOne",
"value": "StatusOne"
},
{
"name": "StatusTwo",
"value": "StatusTwo"
},
{
"name": "StatusThree",
"value": "StatusThree"
}
]
}
}
}
}
New version:
{
"definitions": {
"SomeStatus": {
"description": "Some status description",
"enum": [
"StatusOne",
"StatusTwo",
"StatusNew"
],
"type": "string",
"x-ms-enum": {
"name": "SomeStatus",
"modelAsString": false,
"values": [
{
"name": "StatusOne",
"value": "StatusOne"
},
{
"name": "StatusTwo",
"value": "StatusTwo"
},
{
"name": "StatusNew",
"value": "StatusNew"
}
]
}
}
}
}
Markdown output:
Changed response : 200 OK
Changed items (object):
* Changed property `status` (string)
Added enum value:
* `StatusNew`
コントリビューションガイド
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
評価
この issue はまだ評価されていません。