Skip to content

[java][doc] Fix Makdown examples: wrong collection type used to initialize Sets#23160

Merged
wing328 merged 2 commits intoOpenAPITools:masterfrom
robinmarechal:fix/java-md-examples-wrong-collection-type
Mar 7, 2026
Merged

[java][doc] Fix Makdown examples: wrong collection type used to initialize Sets#23160
wing328 merged 2 commits intoOpenAPITools:masterfrom
robinmarechal:fix/java-md-examples-wrong-collection-type

Conversation

@robinmarechal
Copy link
Contributor

@robinmarechal robinmarechal commented Mar 6, 2026

As mentioned in #23072 (comment), the generated documentation uses Arrays.asList() to initialize arrays, without checking uniqueItems Cf. AbstractJavaCodegen#setParameterExampleValue(CodegenParameter).

This leads to invalid examples like Set<String> tags = Arrays.asList();

This simple change checks uniqueItems. If true, it uses new LinkedHashSet<>() instead of Arrays.asList().

I did not create a new issue for this simple change, if I should create one just tell me.

PR checklist

  • Read the contribution guidelines.
  • Pull Request title clearly describes the work in the pull request and Pull Request description provides details about how to validate the work. Missing information here may result in delayed response from the community.
  • 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.
  • File the PR against the correct branch: master (upcoming 7.x.0 minor release - breaking changes with fallbacks), 8.0.x (breaking changes without fallbacks)
  • If your PR solves a reported issue, reference it using GitHub's linking syntax (e.g., having "fixes #123" present in the PR description)
  • If your PR is targeting a particular programming language, @mention the technical committee members, so they are more likely to review the pull request.

@bbdouglas (2017/07) @sreeshas (2017/08) @jfiala (2017/08) @lukoyanov (2017/09) @cbornet (2017/09) @jeff9finger (2018/01) @karismann (2019/03) @Zomzog (2019/04) @lwlee2608 (2019/10) @martin-mfg (2023/08)


Summary by cubic

Fix Java docs example generation: when uniqueItems is true, Set examples now use LinkedHashSet instead of Arrays.asList. This prevents invalid examples like Set tags = Arrays.asList() and updates the petstore sample docs accordingly.

Written for commit 7955375. Summary will update on new commits.

Copy link
Contributor

@cubic-dev-ai cubic-dev-ai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

No issues found across 30 files

Copy link
Contributor

@Chrimle Chrimle left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why use a concrete implementation? Cleaner, and less opinionated to use the more common Set static methods.

} else {
example = "Arrays.asList()";
if (p.uniqueItems) {
example = "new LinkedHashSet<>()";
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
example = "new LinkedHashSet<>()";
example = "Set.of()";

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This comment is not relevant, and may be marked as "resolved" 👍

}
example = "Arrays.asList(" + innerExample + ")";
if (p.uniqueItems) {
example = "new LinkedHashSet<>(" + example + ")";
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
example = "new LinkedHashSet<>(" + example + ")";
example = "Set.of(" + example + ")";

Copy link
Contributor Author

@robinmarechal robinmarechal Mar 7, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

afaik, Set.of(Arrays.asList(xxx)) will create a Set<List<Xxx>>, not a Set<Xxx>.
So this change would generate an invalid syntax.

Also, the reason for the LinkedHashSet instead of Set is to keep insertion order. But yeah, in those examples the element order doesn't really matter.

I can use Set.of() for the empty set, but not here

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hmm, ordering in Sets is an interesting topic. I'm not sure if there is an established standard set in either OpenAPI or openapi-generator 🤔 (I just realized that LinkedHashSet is THE standard used in openapi-generator, so this is a non-issue)

Yeah, I did not know what the type of example was, that would indeed be incorrect 😄


I left my comment a bit open-ended, because I wasn't completely sure, but now I'm convinced this is the correct solution 👍 Thanks for the patience @robinmarechal 😊

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

How come I cannot resolve my own comments @wing328, is that an admin feature? 🤔

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

i've no idea either.

Copy link
Contributor

@Chrimle Chrimle left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks great ❤️

@wing328 wing328 merged commit c0a7652 into OpenAPITools:master Mar 7, 2026
133 checks passed
@wing328 wing328 added this to the 7.21.0 milestone Mar 7, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants