swagger-api / swagger-api/swagger-codegen

v3.0.0: CodegenParameter examples have values like “param_name_example” instead of actual value

Open
#12,182 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

This is only actual for examples of API parameters provided in the yaml file. Examples for models properties are working fine.
For example, this code

  @Override
  public void postProcessParameter(CodegenParameter parameter) {
    super.postProcessParameter(parameter);
    if(parameter.example != null) System.out.printf("Example for %s is %s\n", parameter.paramName, parameter.example);
  }

will output

Example for portfolio is portfolio_example
Example for ticker is ticker_example
Example for query is query_example

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 tracing CodegenParameter.postProcessParameter and how API parameter examples from the YAML definition are assigned. Compare that path with the working model-property examples, then verify that parameters with explicit YAML examples retain their actual values instead of generated placeholder text.

Written by the indexing model from the issue text.

Assessment

Tech stack
java, openapi
Domain
api, tooling
Issue type
Bug
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.