OpenAPITools / OpenAPITools/openapi-generator

[BUG][Kotlin][Multiplatform] byte[] is represented as List<Base64ByteArray> instead of Base64ByteArray

Open
#12,660 1 comment 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

I have a field in my Java DTO that is of type byte[]. Swagger spec generated for it looks like this:

          "responseBody": {
            "type": "array",
            "items": {
              "type": "string",
              "format": "byte"
            }
          }
openapi-generator version

6.0.1-SNAPSHOT

OpenAPI declaration file content or url
          "responseBody": {
            "type": "array",
            "items": {
              "type": "string",
              "format": "byte"
            }
          }
Generation Details
generate -g kotlin --library multiplatform ...
Related issues/PRs

None found.

Suggest a fix

It looks straightforward - an array of bytes should be mapped to just Base64ByteArray, not List<Base64ByteArray>. Regarding place in the code, probably something around this place: https://github.com/OpenAPITools/openapi-generator/blob/b02fd28ba638a606785c952d1227f15dfd8660bf/modules/openapi-generator/src/main/java/org/openapitools/codegen/languages/KotlinClientCodegen.java#L701

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 in modules/openapi-generator/src/main/java/org/openapitools/codegen/languages/KotlinClientCodegen.java around the referenced line, then generate the provided schema with the Kotlin multiplatform library. Confirm how an array of byte-formatted strings is mapped. Done means the generated type is Base64ByteArray rather than List.

Written by the indexing model from the issue text.

Assessment

Tech stack
kotlin
Domain
tooling
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.