Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Incorrect OpenAPI specification produced for an Iterable of enums in Scala #4675

Open
nils1k opened this issue May 21, 2024 · 0 comments
Open

Comments

@nils1k
Copy link

nils1k commented May 21, 2024

Describe the bug

When I have a field of type Iterable of an enum, e.g. a Set or a Seq, then springdoc is not generating the correct OpenAPI specification.

To Reproduce
Steps to reproduce the behavior:

What version of spring-boot you are using?
Version 3.2.5.

What modules and versions of swagger-core are you using?
I'm using version 2.5.0 of the org.springdoc:springdoc-openapi-starter-webmvc-ui module, which in turn has a dependency on version 2.2.21 on io.swagger.core.v3:swagger-core-jakarta.

What is the actual and the expected result using OpenAPI Description (yml or json)?
Expected result:

"fareClasses": {
    "type": "array",
    "description": "FareClasses",
    "items": {
        "type": "string"
    }
}

Actual result:

"fareClasses": {
    "type": "array",
    "description": "FareClasses",
    "items": {
        "type": "string",
        "enum": [
            "FIRST_CLASS",
            "SECOND_CLASS",
            "THIRD_CLASS",
            "ECONOMY_CLASS"
        ]
    }
}

Please refer to the sample code that reproduces the issue.

Expected behavior

The fareClasses field should be an enum.

I originally posted this issue in the springdoc issue tracker, but realised that this might be an issue in swagger-core.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant