All of the code for the SDKs are generated from the vCenter REST APIs using the VMware OpenAPI Generator and the OpenAPI Generator. This means that any changes you would like to contribute to the SDK itself will need to be made through the OpenAPI generator templates. If you make contributions directly to the code, it will be overwritten on the next generation. The templates can be found here. For information on how the generation process works, see the wiki page here.
The samples are not generated code, so feel free to modify, extend, or contribute to the samples. If you choose to contribute to the samples, please see below for the process on how to do this.
Please include any information about what is required to run the samples. For example, if the sample expects a specific set of resources to be available, please list those so that others will know that the sample requires that expectation to run properly.
Include the following information when possible. Inclusion of information provides valuable information to consumers of the resource.
- Which vSphere version was the sample developed/tested against?
- Which SDK version was the sample developed/tested against?
- Which Ruby version was the sample developed/tested against?
- Follow the GitHub process
- Please use one branch per sample or change-set
- Please use pull request per sample
- Please post the sample output along with the pull request
- If you include a license with your sample, use the project license
Please conform to the Ruby Style Guide. Check your code by running RuboCop using Bundler (bundle exec rubocop [filename]
).