Mark down changelog generation - enum rename interpreted as added
還沒有人認領這個 Issue。
評估
這個 Issue 還沒有評估資料。
描述
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`
- 主要語言
- Java
- 星號
- 1.1k
- 分支
- 190
- PR 合併指標
- 30 天內沒有已合併 PR
貢獻指南
從這裡開始
- 先讀完整個 Issue,再讀專案的貢獻指南。
- 在 Issue 下留言說明你要接手 —— 這能避免兩個人做同樣的事。
- Fork 儲存庫,在一個分支上完成修改。
- 送出 Pull Request,並在描述裡引用這個 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
-
documentation
難度 2/5 1-3 小時 新手友好度 65/100
inu-appcenter/memorIN-backend#288 ·
-
難度 2/5 1-3 小時 新手友好度 65/100
-
frontend maui-pilot pilot-ask question
難度 2/5 1-3 小時 新手友好度 75/100
-
難度 2/5 1-3 小時 新手友好度 75/100
-
area/plugin
難度 2/5 1-3 小時 新手友好度 75/100
kestra-io/plugin-kestra#190 ·