OpenAPITools / OpenAPITools/openapi-generator

[BUG][Java] Examples in Specification File Are Not Appearing in Generated Code or UI

Open
#15,930 0 comments 1 reaction 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

The generation process runs without any problems. However, the parameter-example from the definition file is not included in the generated code.

The definition file was tested with the Swagger Editor, which shows the correct result with the given input.

Definition-File:
image

UI-Output
image

openapi-generator version
  • Spring Boot: 3.1.1
  • openapi-generator-maven-plugin: 6.6.0

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 generation with the definition file shown in the issue and the openapi-generator-maven-plugin 6.6.0 setup. Trace how parameter examples are handled for the Java/Spring Boot generator and its UI output; done means the supplied example appears in both generated code and the UI.

Written by the indexing model from the issue text.

Assessment

Tech stack
java, openapi, spring-boot
Domain
api, backend, tooling
Issue type
Bug
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
20/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.