OpenAPITools / OpenAPITools/openapi-generator

[BUG][JAVA] Schema called 'ByteArray' produces Java type byte[] regardless of actual schema

Open
#19,688 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?
  • 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

If you create a schema under components called ByteArray the generator produces Java type byte[] regardless of the actual schema. I expect it to use the specified schema instead.

openapi-generator version

7.8.0

OpenAPI declaration file content or url

https://github.com/erikhofer/openapi-generator-bytearray-bug/blob/main/src/main/resources/openapi.yaml

Generation Details

See https://github.com/erikhofer/openapi-generator-bytearray-bug/blob/main/pom.xml

Steps to reproduce
git clone https://github.com/erikhofer/openapi-generator-bytearray-bug.git
cd openapi-generator-bytearray-bug
mvn generate-sources

Look at target/generated-sources/openapi/src/main/java/org/openapitools/api/ExampleApi.java. The method getByteArray demonstrates the faulty generated type while getSomethingElse works correctly.

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

Clone the linked reproduction project, inspect src/main/resources/openapi.yaml and pom.xml, then run mvn generate-sources. Compare getByteArray and getSomethingElse in target/generated-sources/openapi/src/main/java/org/openapitools/api/ExampleApi.java and trace the Java generator's handling of the ByteArray schema. Done means the generated type follows the schema rather than the schema name.

Written by the indexing model from the issue text.

Assessment

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

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.