Hacktoberfest 2026 : les issues que les mainteneurs ont marquées pour octobre, ouvertes et accessibles aux débutants. Parcourir les issues Hacktoberfest

Mark down changelog generation - enum rename interpreted as added

Ouverte
#828 1 commentaire 1 réaction 1 personne assignée Voir sur GitHub

Personne n'a encore pris cette issue.

Évaluation

Cette issue n'a pas encore été évaluée.

Description

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`
Langage dominant
Java
Étoiles
1.1k
Forks
190
Aucune PR mergée en 30 j

Guide de contribution

Ouvrir le guide de contribution

Par où commencer

  1. Lisez l'issue en entier, puis le guide de contribution du projet.
  2. Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
  3. Forkez le dépôt et travaillez sur une branche.
  4. Ouvrez une pull request qui référence le numéro de l'issue.

Autres issues de OpenAPITools/openapi-diff

Toutes les issues de OpenAPITools/openapi-diff

Issues similaires

Plus d'issues Java

Recevez les nouvelles issues par e-mail

Un résumé court des issues GitHub adaptées aux débutants.