Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add an option to skip operation examples #8731

Merged
merged 2 commits into from
Feb 20, 2021
Merged

Conversation

wing328
Copy link
Member

@wing328 wing328 commented Feb 17, 2021

Add an option to skip operation examples to avoid potential JVM out of memory errors

Closes #6597
Closes #8682
Closes #4398

cc @OpenAPITools/generator-core-team

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 
    ./bin/generate-samples.sh
    ./bin/utils/export_docs_generators.sh
    
    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*.
    For Windows users, please run the script in Git BASH.
  • File the PR against the correct branch: master, 5.1.x, 6.0.x
  • If your PR is targeting a particular programming language, @mention the technical committee members, so they are more likely to review the pull request.

@wing328 wing328 merged commit 9c20050 into master Feb 20, 2021
@wing328 wing328 deleted the skip-example-generator branch February 20, 2021 03:52
* @return a reference to this Builder
*/
public Builder withSkipOperationExample(Boolean skipOperationExample) {
this.skipOperationExample = skipOperationExample != null ? skipOperationExample : Boolean.valueOf(DEFAULT_REMOVE_OPERATION_ID_PREFIX);
Copy link

Choose a reason for hiding this comment

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

This appears to be the wrong default that is assigned - should be DEFAULT_SKIP_OPERATION_EXAMPLE i suppose

@kvn-shn
Copy link

kvn-shn commented Jun 8, 2021

How is this supposed to work? I added <skipOperationExample>true</skipOperationExample> to the Maven plugin (version 5.1.1, using spring generator and the delegate pattern) but the massive String exampleString = "..." is still generated into the XxxApiDelegate interface default method implementations.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
3 participants