Skip to content

Update tests to reduce size for webclient samples#23185

Merged
wing328 merged 1 commit intomasterfrom
23031-followup
Mar 9, 2026
Merged

Update tests to reduce size for webclient samples#23185
wing328 merged 1 commit intomasterfrom
23031-followup

Conversation

@wing328
Copy link
Copy Markdown
Member

@wing328 wing328 commented Mar 9, 2026

a follow up PR to #23031

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.

Summary by cubic

Reduce the webclient Java sample used in tests by switching to a minimal Petstore spec (addPet only), cutting generated files and speeding up CI.

  • Refactors
    • Point bin/configs/java-webclient-springBoot4-jackson3.yaml to modules/openapi-generator/src/test/resources/3_0/petstore-addpet-only.yaml.
    • Regenerate samples to include only PetApi.addPet; remove other Petstore APIs/models/docs to shrink output.
    • Update default base URL to http://petstore.swagger.io/v2 and refresh descriptions in generated headers/README.
    • Adjust models: Pet.photoUrls is now List<String>; Category.name is optional; minor doc tweaks for Tag/Category.
    • Replace example code in README to use PetApi; drop references to removed APIs.

Written for commit 74b151e. Summary will update on new commits.

@wing328 wing328 marked this pull request as ready for review March 9, 2026 06:59
@wing328 wing328 added this to the 7.21.0 milestone Mar 9, 2026
Copy link
Copy Markdown
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.

1 issue found across 187 files

Note: This PR contains a large number of files. cubic only reviews up to 75 files per PR, so some files may not have been reviewed.

Prompt for AI agents (unresolved issues)

Check if these issues are valid — if so, understand the root cause of each and fix them. If appropriate, use sub-agents to investigate and fix each issue separately.


<file name="samples/client/petstore/java/webclient-springBoot4-jackson3/README.md">

<violation number="1" location="samples/client/petstore/java/webclient-springBoot4-jackson3/README.md:9">
P2: The new README text incorrectly tells users to use an API key, but this generated client is documented and demonstrated with OAuth (`petstore_auth`) only.</violation>
</file>

Reply with feedback, questions, or to request a fix. Tag @cubic-dev-ai to re-run a review.

- Generator version: 7.21.0-SNAPSHOT

This spec is mainly for testing Petstore server and contains fake endpoints, models. Please do not use this for any other purpose. Special characters: \" \\
This is a sample server Petstore server. For this sample, you can use the api key `special-key` to test the authorization filters.
Copy link
Copy Markdown
Contributor

@cubic-dev-ai cubic-dev-ai bot Mar 9, 2026

Choose a reason for hiding this comment

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

P2: The new README text incorrectly tells users to use an API key, but this generated client is documented and demonstrated with OAuth (petstore_auth) only.

Prompt for AI agents
Check if this issue is valid — if so, understand the root cause and fix it. At samples/client/petstore/java/webclient-springBoot4-jackson3/README.md, line 9:

<comment>The new README text incorrectly tells users to use an API key, but this generated client is documented and demonstrated with OAuth (`petstore_auth`) only.</comment>

<file context>
@@ -6,7 +6,7 @@ OpenAPI Petstore
 - Generator version: 7.21.0-SNAPSHOT
 
-This spec is mainly for testing Petstore server and contains fake endpoints, models. Please do not use this for any other purpose. Special characters: \" \\
+This is a sample server Petstore server. For this sample, you can use the api key `special-key` to test the authorization filters.
 
 
</file context>
Suggested change
This is a sample server Petstore server. For this sample, you can use the api key `special-key` to test the authorization filters.
This is a sample Petstore server. For this sample, configure OAuth (`petstore_auth`) to test the authorization filters.
Fix with Cubic

@wing328 wing328 merged commit 6804cea into master Mar 9, 2026
150 checks passed
@wing328 wing328 deleted the 23031-followup branch March 9, 2026 07:44
davidricodias pushed a commit to davidricodias/openapi-generator that referenced this pull request Mar 11, 2026
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