OpenAPITools / OpenAPITools/openapi-generator

[BUG][Kotlin] OK HTTP: collectionDelimiter not imported

Open
#20,428 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 a generated Api Client has a header field with schema array of an enum it uses the method collectionDelimiter which is provided in the infrastructure package (ApiAbstractions.kt)

openapi-generator version

7.10.0

OpenAPI declaration file content or url

Just need an enum array as parameter anywhere.
`
parameters:

  • name: values
    in: header
    required: false
    schema:
    type: array
    description: All goods receipt types that should be sent back to the device
    items:
    type: string
    description: Type of goods receipt request
    enum:
    - MULTIPLE
    - ENUM
    - VALUES
    `
Generation Details

Configure the kotlin generator to use okhttp

Steps to reproduce

Generate any API

Suggest a fix

Add the collectionDelimiter import always, or atleast when using it.
File https://github.com/OpenAPITools/openapi-generator/blob/master/modules/openapi-generator/src/main/resources/kotlin-client/libraries/jvm-okhttp/api.mustache

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 modules/openapi-generator/src/main/resources/kotlin-client/libraries/jvm-okhttp/api.mustache and inspect how collectionDelimiter is referenced, along with ApiAbstractions.kt where it is provided. Generate a Kotlin client using the JVM OkHttp library with an enum array header parameter. Done means the generated client imports collectionDelimiter when needed and compiles successfully.

Written by the indexing model from the issue text.

Assessment

Tech stack
kotlin, openapi
Domain
api, tooling
Issue type
Bug
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
55/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.