OpenAPITools / OpenAPITools/openapi-generator

[BUG][SPRING] Default value for query parameter not exported to code and doc

Open
#3,863 3 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

openapi: 3.0.0
Default value for query parameter not exported to code and doc.

openapi-generator version

Current, available in https://app.swaggerhub.com

OpenAPI declaration file content or url

https://app.swaggerhub.com/apis/marikori/default_value_bug/1.0.0

Command line used for generation

Use swaggerhub UI to generate documentation - Export -> Documentation -> html2:
image

Use swaggerhub UI to generate code - Export -> Server Stub -> spring:
image

Steps to reproduce
  1. Define default value for parameter in OAS - line 14 (dafault = 0 for par1) in https://app.swaggerhub.com/apis/marikori/default_value_bug/1.0.0
  2. Export html2 documentation using codegen available in swaggerbub (see above).
  3. Export Spring server code using codegen available in swaggerbub (see above).

Results:
2. Default value not defined in exported documentation.
3. Default value not define in exported code.

image

exported_code_and_doc.tar.gz

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 by reproducing the issue with the OpenAPI declaration at SwaggerHub, using the documented Export > Documentation > html2 and Export > Server Stub > spring entry points. Compare the generated documentation and Spring server code for the parameter on line 14, and consider the issue done when its default value appears correctly in both outputs.

Written by the indexing model from the issue text.

Assessment

Tech stack
java, openapi, spring
Domain
api, backend, documentation
Issue type
Bug
Difficulty
4/5
Estimated time
3-5 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.