OpenAPITools / OpenAPITools/openapi-generator

[BUG] generated code doesn't compile when @RequestMapping contains multiple values for produces attribute

Open
#11,429 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

In case of multiple media types that can be produced by the mapped handler, the values for the attribute produces in @RequestMapping annotation are not separated by a coma.

openapi-generator version

5.1.1

OpenAPI declaration file content or url
            responses:
                '200':
                    description: A file
                    content:
                        application/vnd.ms-excel:
                            schema:
                                type: string
                                format: binary
                '400':
                    $ref: '#/components/responses/BadRequest'
Generation Details

Gradle plugin task openApiGenerate
Generator spring

Compilation errors :

        error: '}' expected
        produces = { "application/vnd.ms-excel""application/json" },  

Extract of generated source code :

        produces = { "application/vnd.ms-excel""application/json" },  <--- missing comma here
Related issues/PRs

https://github.com/OpenAPITools/openapi-generator/issues/896

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

Reproduce the issue with the Gradle plugin task openApiGenerate using the spring generator and the supplied response media types. Inspect the generated @RequestMapping annotation where produces contains multiple values. The work is done when the generated Java source separates those values with commas and compiles successfully.

Written by the indexing model from the issue text.

Assessment

Tech stack
java, 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.