OpenAPITools / OpenAPITools/openapi-generator

Android: list of enums generates syntax error due to mustache HTML encoding

Open
#2,124 5 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Client: Android 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?
  • Have you validated the input using an OpenAPI validator (example)?
  • What's the version of OpenAPI Generator used?
  • Have you search for related issues/PRs?
  • What's the actual output vs expected output?
  • [Optional] Bounty to sponsor the fix (example)
Description

In my Swagger 2 spec, I have a Definition with an array property. Its items are defined as strings with an enum-erated list of values. When I use the "android" generator, it incorrectly HTML-encodes the List definition, resulting in a syntax error.

The property looks like:

        "gender": {
          "type": "array",
          "items": {
            "type": "string",
            "enum": [
              "Male",
              "Female"
            ]
          }
        },

and the resulting Java code looks like:

  public enum List<GenderEnum> {
     Male,  Female, 
  };
openapi-generator version

4.0.0-SNAPSHOT

OpenAPI declaration file content or url

https://gist.github.com/jacobweber/c21e944d6e627a92ddcfd02242aca117

Command line used for generation
java -jar /path/to/openapi-generator-cli.jar generate -i /path/to/spec.json -g android -o /path/to/output
cd /path/to/output
mvn clean package
Steps to reproduce

See above

Related issues/PRs

None

Suggest a fix

None

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

Start with the provided Swagger 2 definition and run the documented android generator command to reproduce the generated enum. Inspect the generated Java model containing the array enum and verify that the output no longer HTML-encodes the List type and compiles with Maven.

Written by the indexing model from the issue text.

Assessment

Tech stack
android, java, openapi
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.