OpenAPITools / OpenAPITools/openapi-generator

[BUG] [Elm] Outputs duplicate types, as well as overlapping types with same name

Ouverte
#13,653 0 commentaires 0 réactions 0 personnes assignées Voir sur GitHub

Personne n'a encore pris cette issue.

Issue: Bug
Langage dominant
Java
Étoiles
26.8k
Forks
7.7k
Métriques de merge des PR
Métriques de PR en attente

Description

Bug Report Checklist
  • Have you provided a full/minimal spec to reproduce the issue?
  • Using the full Stripe API spec.

  • Have you validated the input using an OpenAPI validator (example)?
  • I used the CLI with validate and it found no issues.

  • Have you tested with the latest master to confirm the issue still exists?
  • Yes

  • Have you searched for related issues/PRs?
  • What's the actual output vs expected output?
Description
openapi-generator version

Latest master

OpenAPI declaration file content or url

https://raw.githubusercontent.com/stripe/openapi/master/openapi/spec3.json

Generation Details
java -jar modules/openapi-generator-cli/target/openapi-generator-cli.jar generate    -i https://raw.githubusercontent.com/stripe/openapi/master/openapi/spec3.json    -g elm    -o ./elm-stripeFix

All in the same file, there will be this Status:

type Status
    = StatusActive
    | StatusBlocked
    | StatusInactive


statusVariants : List Status
statusVariants =
    [ StatusActive
    , StatusBlocked
    , StatusInactive
    ]


stringFromStatus : Status -> String
stringFromStatus model =
    case model of
        StatusActive ->
            "active"

        StatusBlocked ->
            "blocked"

        StatusInactive ->
            "inactive"

...right along with this Status somewhere else:

type Status
    = StatusExpired
    | StatusLost
    | StatusSubmitted
    | StatusUnsubmitted
    | StatusWon


statusVariants : List Status
statusVariants =
    [ StatusExpired
    , StatusLost
    , StatusSubmitted
    , StatusUnsubmitted
    , StatusWon
    ]


stringFromStatus : Status -> String
stringFromStatus model =
    case model of
        StatusExpired ->
            "expired"

        StatusLost ->
            "lost"

        StatusSubmitted ->
            "submitted"

        StatusUnsubmitted ->
            "unsubmitted"

        StatusWon ->
            "won"


Obviously this causes a conflict, and fixing it is not trivial as all references to Status are now ambiguous.

Suggest a fix

Ideally, have types belonging to different domains go in separate type modules.

At the least, add a number or underscore to the end of one of them if need be.

Naive fix would be to merge the enums and just treat them as one.

Also, this includes totally identical types and encoder/decoders. They can have everything exactly the same, and still be repeated 5 different places in the file.

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.

Piste de recherche

Reproduisez le problème avec la spécification Stripe OpenAPI et la commande de génération Elm indiquée dans le rapport, puis examinez la sortie Elm générée à la recherche de types en double et en conflit. La tâche est terminée lorsque les types générés ainsi que leurs encodeurs, décodeurs et références n’entrent plus en conflit, et que les définitions identiques ne sont pas répétées.

Rédigé par le modèle d'indexation à partir du texte de l'issue.

Évaluation

Stack technique
elm, openapi
Domaine
api, tooling
Type d'issue
Bug
Difficulté
5/5
Temps estimé
Plus d'une semaine
Activité
À l'abandon
Clarté
Plutôt claire
Accessibilité débutants
30/100

Recevez les nouvelles issues par e-mail

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