Mark down changelog generation - enum rename interpreted as added
Ninguém assumiu esta issue ainda.
Avaliação
Esta issue ainda não foi avaliada.
Descrição
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`
- Linguagem predominante
- Java
- Estrelas
- 1.1k
- Forks
- 190
- Métricas de merge de PRs
- Nenhum PR com merge em 30d
Guia de contribuição
Primeiros passos
- Leia a issue inteira e depois o guia de contribuição do projeto.
- Comente na issue dizendo que vai assumir — evita que duas pessoas façam o mesmo trabalho.
- Faça um fork do repositório e trabalhe em uma branch.
- Abra um pull request que referencie o número da issue.
Mais de OpenAPITools/openapi-diff
-
enhancement
Dificuldade 2/5 1-3 horas Facilidade para iniciantes 68/100
OpenAPITools/openapi-diff#506 ·
-
good first issue help wanted
Dificuldade 2/5 1-3 horas Facilidade para iniciantes 68/100
OpenAPITools/openapi-diff#364 ·
-
bug OpenAP 3.1.0 Support
Dificuldade 3/5 1-2 dias Facilidade para iniciantes 68/100
OpenAPITools/openapi-diff#910 · 1 comentário ·
-
Render capabilities
Dificuldade 3/5 1-2 dias Facilidade para iniciantes 55/100
OpenAPITools/openapi-diff#893 · 1 comentário ·
-
Breaking/Non-Breaking classification
Dificuldade 3/5 1-2 dias Facilidade para iniciantes 55/100
OpenAPITools/openapi-diff#886 ·
Todas as issues de OpenAPITools/openapi-diff
Issues semelhantes
-
executions.Query — startDate and timeRange filters are sent with inverted comparison operators Abertaarea/plugin
Dificuldade 2/5 1-3 horas Facilidade para iniciantes 75/100
kestra-io/plugin-kestra#190 ·
-
litertlm-android AAR ships no consumer ProGuard rules → "mid == null" SIGABRT in minified apps Aberta
Dificuldade 2/5 1-3 horas Facilidade para iniciantes 70/100
google-ai-edge/LiteRT-LM#3739 ·
-
bug
Dificuldade 2/5 1-3 horas Facilidade para iniciantes 75/100
-
Dificuldade 2/5 1-3 horas Facilidade para iniciantes 75/100
integra-team-red/meet-map#249 ·
-
[Studio][Bug] Cancelled create-user dialog keeps the password and admin switch for the next attempt Aberta
Dificuldade 2/5 1-3 horas Facilidade para iniciantes 75/100
apache/rocketmq-dashboard#5064 ·