OpenAPITools / OpenAPITools/openapi-generator

[BUG] Spring generator - example is ignored in query parameter

Open
#22,904 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

Description

Extract of yml file :

parameters:
- in: path
name: test
required: true
description: My test
schema:
type: string
example: todo

The spring generator generate :

@NotNull @Parameter(name = "test", description = "My test", required = true, in = ParameterIn.QUERY) @Valid @RequestParam(value = "origine", required = true) String test

Bug

Example "todo" is not added.

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 supplied OpenAPI YAML and the generated Spring method shown in the issue. Run the Spring generator with this parameter definition, then trace how the schema example is handled for generated parameters. Done means the generated output includes the example value "todo" in the appropriate parameter annotation.

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.