Repository navigation
Update samples, workflow to test new Java rest-assured sample - #25110
Merged
Merged
Conversation
Contributor
There was a problem hiding this comment.
1 issue found across 167 files
Prompt for AI agents (unresolved issues)
Check if these issues are valid — if so, understand the root cause of each and fix them. When an issue isn't valid or won't be fixed in this PR, reply in its thread with the reason and then resolve the thread. If appropriate, use sub-agents to investigate and fix each issue separately.
<file name="samples/client/petstore/java/rest-assured-jackson3/src/main/java/org/openapitools/client/api/PetApi.java">
<violation number="1" location="samples/client/petstore/java/rest-assured-jackson3/src/main/java/org/openapitools/client/api/PetApi.java:85">
P3: The generated javadoc "* return Pet" is not a valid Javadoc tag — it should be "@return Pet", otherwise IDEs and javadoc render it as plain text and the operation shows no return documentation. Fix the root cause in the template: change "* return {{.}}" to "* @return {{.}}" in Java/libraries/rest-assured/api.mustache and regenerate, since a manual edit here would be overwritten on the next sample regeneration.</violation>
</file>
Reply with feedback, questions, or to request a fix.
Re-trigger cubic
| * | ||
| * | ||
| * @see #body Pet object that needs to be added to the store (required) | ||
| * return Pet |
Contributor
There was a problem hiding this comment.
P3: The generated javadoc "* return Pet" is not a valid Javadoc tag — it should be "@return Pet", otherwise IDEs and javadoc render it as plain text and the operation shows no return documentation. Fix the root cause in the template: change "* return {{.}}" to "* @return {{.}}" in Java/libraries/rest-assured/api.mustache and regenerate, since a manual edit here would be overwritten on the next sample regeneration.
Prompt for AI agents
Check if this issue is valid — if so, understand the root cause and fix it. When an issue isn't valid or won't be fixed in this PR, reply in its thread with the reason and then resolve the thread. At samples/client/petstore/java/rest-assured-jackson3/src/main/java/org/openapitools/client/api/PetApi.java, line 85:
<comment>The generated javadoc "* return Pet" is not a valid Javadoc tag — it should be "@return Pet", otherwise IDEs and javadoc render it as plain text and the operation shows no return documentation. Fix the root cause in the template: change "* return {{.}}" to "* @return {{.}}" in Java/libraries/rest-assured/api.mustache and regenerate, since a manual edit here would be overwritten on the next sample regeneration.</comment>
<file context>
@@ -126,6 +82,7 @@ public PetApi reqSpec(Consumer<RequestSpecBuilder> reqSpecCustomizer) {
*
*
* @see #body Pet object that needs to be added to the store (required)
+ * return Pet
*/
public static class AddPetOper implements Oper {
</file context>
2 tasks done
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
a follow up pr to #25077
PR checklist
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.
Summary by cubic
Switches the
rest-assured-jackson3Java sample from the full petstore-with-fake-endpoints specification to the minimalpetstore-addpet-onlyspec, shrinking the generated client to just theaddPetoperation. Adds the sample to the JDK17 workflow so CI exercises it, and bumps the sample'sjackson-databind-nullabledependency to 0.2.12.Written for commit e76f57b. Summary will update on new commits.