[thiswasdumb]

Added logic so when multiple examples exist in 3.1 spec, they are generated int he corresponding @Schema notation and can be referenced as needed.

Serves as a fix for #24755

PR checklist

• Read the contribution guidelines.
• Run the following to build the project and update samples:

  ./mvnw clean package || exit
  ./bin/generate-samples.sh ./bin/configs/*.yaml || exit
  ./bin/utils/export_docs_generators.sh || exit
  

  (For Windows users, please run the script in WSL)
  Commit all changed files.
  This is important, as CI jobs will verify all generator outputs of your HEAD commit as it would merge with master.
  These must match the expectations made by your contribution.
  You may regenerate an individual generator by passing the relevant config(s) as an argument to the script, for example ./bin/generate-samples.sh bin/configs/java*.
  IMPORTANT: Do NOT purge/delete any folders/files (e.g. tests) when regenerating the samples as manually written tests may be removed.
• If your PR is targeting a particular programming language, @mention the technical committee members, so they are more likely to review the pull request.

---

Summary by cubic

Renders OpenAPI 3.1 examples values into the @Schema annotation for Java Spring generators, fixing #24755.

New Features

• Adds examples parameter support to @Schema when the spec declares multiple example values; single values render as a one-element array and properties without examples are unchanged.

^{Written for commit d677a8c. Summary will update on new commits.}

[jpfinne]

@thiswasdumb Looks good.

Thanks for the feature

[thiswasdumb]

@thiswasdumb Looks good.

Thanks for the feature

Thank you! I am just updating samples and hopefully pipeline will pass soon :)

[jpfinne]

@thiswasdumb Just an idea to simplify the use of existing templates:

public String getExample() {
    if (example != null) {
       return example;
    }
    if (examples != null && !examples.isEmpty()) {
       return examples.get(0);
    }
    return null;
}

So existing templates still work with {{example}}.

And new templates can use:

{{#examples}}{{.}}{{/examples}}
{{^examples}}{{example}}{{/examples}}

[marek-g8i]

@jpfinne I wonder if we should change the semantics of getExample method? I'd rather leave it as is. The code generator should accurately reflect the state of the spec in the generated source code.

[jpfinne]

@jpfinne I wonder if we should change the semantics of getExample method? I'd rather leave it as is. The code generator should accurately reflect the state of the spec in the generated source code.

@marek-g8i an option is the return the best of example and first value from examples.

public String getExample() {
   if (example == null && examples != null && !examples.isEmpty()) {
     return examples.get(0);
   }
   return example;
}

[dymitrstinski-collab]

@thiswasdumb Hi! Are you planning to include this feature in nearest release 7.26?

[thiswasdumb]

@thiswasdumb Hi! Are you planning to include this feature in nearest release 7.26?

@dymitrstinski-collab Hi! Sorry I have just been moving from when I made this to now, but I was going to come back soon. I can hopefully give it a check tonight or tomorrow :)

[dymitrstinski-collab]

@thiswasdumb Please, let me know if any help is required to finish this pull request.

[wing328]

@dymitrstinski-collab please submit a new PR on top of this one and we will review accordingly.

[dymitrstinski-collab]

@wing328 yes, my colleague created this one #25003 and we'd like to have it in the next release, if possible.