OpenAPITools / OpenAPITools/openapi-generator

[BUG] [kotlin] [kotlin-spring] using uniqueItems when returning array in endpoint response generate wrong return type

Open
#20,305 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)
openapi-generator version

7.8.0

OpenAPI declaration file content or url
paths:
  /test:
    get:
      operationId: getTest
      tags:
        - test
      responses:
        200:
          content:
            application/json:
              schema:
                type: array
                uniqueItems: true
                items:
                  type: string
Generated code
fun getTest(): ResponseEntity<set<kotlin.collections.Set<kotlin.String>>> {

expected code:

fun getTest(): ResponseEntity<kotlin.collections.Set<kotlin.String>> {

however, the type is well generated when uniqueItems is used on a property that is inside an object

Steps to reproduce
  • Set up project
  • mvn clean compile

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 Kotlin Spring generator and reproduce the issue using the OpenAPI declaration in the report. Compare the generated endpoint return type for a top-level array with uniqueItems to the expected ResponseEntity<Set> form, then verify that the existing object-property case remains correct.

Written by the indexing model from the issue text.

Assessment

Tech stack
kotlin, openapi, spring
Domain
api, backend, 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.