OpenAPITools / OpenAPITools/openapi-generator

Skip Example-Annotation generation

Open
#10,728 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Java
Stars
26.8k
Forks
7.7k
PR merge metrics
PR metrics pending

Description

Description

I need to skip the generation of examples.

"property": { "type" : "string", "format" : "date", "example" : "2020-00-00" }

The generated code has an ApiModelProperty Annotation with example. I want to have a blank example or no example at all. We use the jaxrs-jersey generator.

I can't find a configOption or additionalProperty-Option to disable this. Any idea?

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 at the jaxrs-jersey generator's ApiModelProperty annotation generation and review the available config and additional properties. Done when an option produces a blank or absent example for the supplied schema.

Written by the indexing model from the issue text.

Assessment

Tech stack
java, openapi
Domain
api, tooling
Issue type
Feature
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.