OpenAPITools / OpenAPITools/openapi-generator

[BUG][JAVA] import mapping of alias types in API interface

Open
#8,548 5 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?
  • 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?
  • [Optional] Sponsorship to speed up the bug fix or feature request (example)
Description

when using importMapping for alias types, the generated code does not use the importmapping in the api interface

Expected
    @POST
    @Path("/{id}")
    Response typeAliasIdPost(@PathParam("id") foo.bar.TypeAlias id);
Actual
    @POST
    @Path("/{id}")
    Response typeAliasIdPost(@PathParam("id") String id);
openapi-generator version

5.0.0

OpenAPI declaration file content or url

https://gist.github.com/PhilippParis/28c40d590b4a9019cb8040b143e09884

Generation Details
<generatorName>jaxrs-spec</generatorName>
<interfaceOnly>true</interfaceOnly>
 <java8>true</java8>
<importMappings>
    <importMapping>TypeAlias=foo.bar.TypeAlias</importMapping>
</importMappings>
Steps to reproduce

run openapi-generator 5.0.0 with specified generation details

Related issues/PRs

https://github.com/OpenAPITools/openapi-generator/issues/3589

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

Use the linked OpenAPI declaration and the listed jaxrs-spec generation settings to reproduce the generated API interface. Compare the alias parameter with the expected foo.bar.TypeAlias import mapping; done means the interface uses the mapped alias type instead of String.

Written by the indexing model from the issue text.

Assessment

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