swagger-api / swagger-api/swagger-codegen

Default value for query parameter not exported to code and doc

Open
#9,710 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Mustache
Stars
17.8k
Forks
6k
PR merge metrics
No merged PRs in 30d

Description

Description

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

Swagger-codegen version

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

Swagger 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

Related issues/PRs
Suggest a fix/enhancement

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 linked OpenAPI declaration and reproduce both exports in SwaggerHub: html2 documentation and the Spring server stub. Compare the generated outputs for the query parameter defined with a default value; the work is done when that default appears correctly in both exported documentation and code.

Written by the indexing model from the issue text.

Assessment

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

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.