Skip to content

Fix value param in Javadoc of addParamToMultipart - #24931

Open
jjohannes wants to merge 1 commit into
OpenAPITools:masterfrom
jjohannes:patch-1
Open

Fix value param in Javadoc of addParamToMultipart#24931
jjohannes wants to merge 1 commit into
OpenAPITools:masterfrom
jjohannes:patch-1

Conversation

@jjohannes

@jjohannes jjohannes commented Sep 11, 2026

Copy link
Copy Markdown

This bug causes the javadoc tool to fail for the generated code with:

error: @param argument "obj" is not a parameter name.
   * @param obj Object

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

Fixes the Javadoc parameter name in the Jersey3 ApiClient template so generated code no longer fails the javadoc tool with @param argument "obj" is not a parameter name.

  • Renames the @param tag from obj to value to match the method signature.

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

Review in cubic

This bug causes the `javadoc` tool to fail for the generated code with:

```
error: @PARAM argument "obj" is not a parameter name.
   * @PARAM obj Object
```
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant