OpenAPITools / OpenAPITools/openapi-generator

[BUG] [JAVA] Enum path parameter generated as string

Open
#13,493 6 comments 4 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?
  • Have you validated the input using an OpenAPI validator (example)?
  • Have you tested with the latest master to confirm the issue still exists?
  • Have you searched for related issues/PRs?
  • What's the actual output vs expected output?
Description

When using an enum as a path parameter, the generated client uses a String as argument

openapi-generator version

6.0.1, but also reproduced in latest master (6.1.1)

OpenAPI declaration file content or url

https://gist.github.com/RInverid/5f4f2c0bf905e9007880671d6b10460d

Generation Details

using the java language, I tried the default & native library configuration, issue still persists

Suggest a fix

I would like the enum classes to be generated (perhaps an inner class of the generated Api class) to be used as arguments.
Or at minimum use the defined enum values as validation for the string input

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 OpenAPI declaration in the linked gist and generate the Java client using the default and native library configurations. Compare the path parameter type with the declared enum; done means the generated client represents the enum appropriately or validates the defined enum values instead of accepting an unrestricted String.

Written by the indexing model from the issue text.

Assessment

Tech stack
java, openapi
Domain
api, tooling
Issue type
Bug
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
38/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.