OpenAPITools / OpenAPITools/openapi-generator

[BUG] Kotlin-retrofit2-gson-coroutines CollectionsFormat.CSVParams default value is set to arrayListOf()

Open
#18,864 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

Open api generator where the code generated gives parameter of type CSVParams gives wrong default implementation, it should create the CSVParams class but instead it is @Query("sort") sort: CSVParams? = arrayListOf("date:desc")

openapi-generator version

7.6.0

OpenAPI declaration file content or url
    SortSchema:
      type: array
      description: |
        ...
      default: [ 'date:desc' ]
      items:
        type: string
        pattern: '^(date|name|popularity|trend)(:(asc|desc))?$'
      example: [ 'date:desc', 'name' ]
Generation Details
        generatorName = "kotlin"
        inputSpec = "$rootDir/data/src/main/assets/openapi/${spec.value}"
        outputDir = "$buildDir/generated/openapi"
        configOptions = [
                dateLibrary         : "java17",
                library             : "jvm-retrofit2",
                serializationLibrary: "gson",
                useCoroutines       : "true"
        ]
        nameMappings = [
                "identifier": "id"
        ]
        modelNamePrefix = "Api"
        apiNameSuffix = "Api"
        generateModelTests = false
        generateApiTests = false
Steps to reproduce
  • Generate retrofit API and classes with openApiGenerate {}
  • Build fails due to compilation error
Related issues/PRs
Suggest a fix

Default value of CSVParams should create an instance of CSVParams class instead of ArrayList

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 provided OpenAPI declaration and generation settings, then run openApiGenerate for the Kotlin jvm-retrofit2 client with Gson and coroutines. Inspect the generated declaration for the CSVParams parameter and compare its default value with the expected CSVParams instance. Done means the generated client compiles and uses the appropriate default type.

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.