OpenAPITools / OpenAPITools/openapi-generator

[BUG] [Elm] Asterisks being allowed in Custom Types (from enums)

Open
#13,652 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Issue: Bug
Dominant language
Java
Stars
26.8k
Forks
7.7k
PR merge metrics
PR metrics pending

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

Puts out the invalid code:

type EnabledEvents
    = EnabledEvents*
    | EnabledEventsAccountApplicationAuthorized
    | EnabledEventsAccountApplicationDeauthorized
    | EnabledEventsAccountExternalAccountCreated
    | EnabledEventsAccountExternalAccountDeleted
    | -- ...

But asterisks are not valid in elm identifiers.

Suggest a fix

Replace with Underscore, if using the same name is truly needed. Otherwise, pick a more descriptive name.

For example, in this case the * value seems to mean "all", so EnabledEventsAll would be ideal.

(That said, I wish these types were all in their own modules, so we could just use qualified names like EnabledEvents.All rather than having long prefixes on every value)

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Run the provided CLI command against the Stripe OpenAPI spec and inspect the generated EnabledEvents declaration. Trace the Elm generator's enum or custom-type naming path to determine how the asterisk becomes part of the constructor name. Done means generated Elm uses valid identifiers while preserving the enum values' intended meaning.

Written by the indexing model from the issue text.

Assessment

Tech stack
elm, java
Domain
tooling
Issue type
Bug
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.