OpenAPITools / OpenAPITools/openapi-generator

[BUG] String default wrong quotation

Open
#2,358 8 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)?
  • What's the version of OpenAPI Generator used?
  • Have you search for related issues/PRs?
  • What's the actual output vs expected output?
  • [Optional] Bounty to sponsor the fix (example)
Description

We use the maven plugin to create our models and interfaces in spring boot.
I wanted to set an optional header parameter to a default value used on the server side. However, I can not define the string correctly. The output is always masked incorrectly with extra double quotes.

openapi-generator version
org.openapitools openapi-generator-maven-plugin 3.3.4
OpenAPI declaration file content or url
components:
    parameters:
        XConsumerId:
            in: header
            name: x-consumer-id
            description: 'filled by gateway'
            required: false
            schema:
                type: string
                default: "c1" # tried also c1 and 'c1' 
            example: c1

Generated code
@ApiParam(value = "filled by gateway" , defaultValue=""c1"") @RequestHeader(value="x-consumer-id", required=false) String xConsumerId

"" of defaultValue is not correct

Command line used for generation

Execute maven plugin

Steps to reproduce
Related issues/PRs
Suggest a fix

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 Maven plugin generation using the supplied OpenAPI parameter declaration and compare the generated @ApiParam defaultValue with the expected c1. Done means the generated Spring Boot interface preserves c1 without extra double quotes; the issue names no source file or test.

Written by the indexing model from the issue text.

Assessment

Tech stack
java, openapi, spring
Domain
api, backend
Issue type
Bug
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
42/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.