Skip to content
GitLab

[BUG][kotlin] Make Kotlin client generate comma separated list for array path params

Merged Administrator requested to merge github/fork/sjoblomj/kotlin-client-comma-separate-arrays into master

Created by: sjoblomj

resolve #7199 (closed)

The Kotlin client codegen currently cannot handle path params of type array. The code being generated for the path is currently this: path = "/stuff/{ids}".replace("{"+"ids"+"}", "$ids"). This works fine, but not if ids is a list or an array, since the toString() method is used to create the string.

With the current code, if ids contains 123 and 456, then path would be set to:

  • /stuff/[123,456] if collectionType is list.
  • /stuff/[Ljava.lang.String;@6a98f353 if collectionType is array.

In both cases, /stuff/123,456 is the expected result.

If we change the code from path = "/stuff/{ids}".replace("{"+"ids"+"}", "$ids") to path = "/stuff/{ids}".replace("{"+"ids"+"}", ids.joinToString(",")), we get the expected result.

OpenAPI Spec demonstrating this:

openapi: 3.0.0
info:
  version: 1.0.0
  title: Demo
paths:
  '/{ids}':
    get:
      parameters:
        - name: ids
          in: path
          required: true
          schema:
            type: array
            items:
              type: string
          style: simple
      responses:
        200:
          description: Successful operation

PR checklist

  • Read the contribution guidelines.
  • Pull Request title clearly describes the work in the pull request and Pull Request description provides details about how to validate the work. Missing information here may result in delayed response from the community.
  • Run the following to build the project and update samples: 
    ./mvnw clean package 
./bin/generate-samples.sh
./bin/utils/export_docs_generators.sh
    Commit all changed files. This is important, as CI jobs will verify all generator outputs of your HEAD commit as it would merge with master. These must match the expectations made by your contribution. You may regenerate an individual generator by passing the relevant config(s) as an argument to the script, for example ./bin/generate-samples.sh bin/configs/java*. For Windows users, please run the script in Git BASH.
  • File the PR against the correct branch: master (5.3.0), 6.0.x
  • If your PR is targeting a particular programming language, @mention the technical committee members, so they are more likely to review the pull request.

@jimschubert @dr4ke616 @karismann @Zomzog @andrewemery @4brunu @yutaka0m