OpenAPITools / OpenAPITools/openapi-generator

[BUG][JAVA] Files resources conflicts with native java.io.File

Open
#6,017 3 comments 1 reaction 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)?
  • 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

We have an endpoint for getting a file GET /api/files/{id} which returns a custom File object. The code generated with openapi-generator is returning a native java.io.File object.

openapi-generator version

4.3.0

OpenAPI declaration file content or url

https://catalyticsdkapi.azurewebsites.net/swagger/v1/swagger.json

Command line used for generation
Steps to reproduce

`$ openapi-generator generate -i https://catalyticsdkapi.azurewebsites.net/swagger/v1/swagger.json -g java -o new --additional-properties=apiPackage=org.catalytic.sdk.api,modelPackage=org.catalytic.sdk.model,dateLibrary=java8,groupId=org.catalytic,invokerPackage=org.catalytic.sdk,java8=true,hideGenerationTimestamp=true --skip-validate-spec

Related issues/PRs
Suggest a fix

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 generation command and the linked swagger.json, then inspect the generated Java client and model output to find where the custom File response becomes java.io.File. Reproduce with OpenAPI Generator 4.3.0; done when the generated client preserves the declared custom File type without the native java.io.File conflict.

Written by the indexing model from the issue text.

Assessment

Tech stack
java
Domain
api, tooling
Issue type
Bug
Difficulty
4/5
Estimated time
3-5 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.