chunkyen opened a new pull request, #13902:
URL: https://github.com/apache/cloudstack/pull/13902

   ## Description
   
   The API documentation for `createKubernetesCluster` does not include syntax 
examples for the `nodeofferings` and `nodetemplates` parameters, making it 
difficult for users to specify different service offerings and templates for 
control vs worker nodes.
   
   This PR adds usage examples to the `@Parameter` descriptions, following the 
same inline example pattern already used by the `cniconfigdetails` parameter in 
the same file.
   
   ## Examples added
   
   **nodeofferings:**
   
nodeofferings[0].node="control"&nodeofferings[0].offering="<service-offering-uuid>"&
   
nodeofferings[1].node="worker"&nodeofferings[1].offering="<service-offering-uuid>"
   
   **nodetemplates:**
   nodetemplates[0].node="control"&nodetemplates[0].template="<template-uuid>"&
   nodetemplates[1].node="worker"&nodetemplates[1].template="<template-uuid>"
   
   ## Context
   
   Discussion: https://github.com/apache/cloudstack/discussions/13395
   
   Thanks to @Pearl1594 for providing the syntax and @DaanHoogland for guiding 
the contribution process.
   
   ## Types of changes
   
   - [ ] Bug fix (non-breaking change which fixes an issue)
   - [x] Documentation change (API parameter descriptions)
   - [ ] New feature (non-breaking change which adds functionality)
   - [ ] Breaking change (fix or feature that would cause existing 
functionality to change)
   
   ## Checklist
   
   - [x] Code formatted according to project style
   - [x] Self-reviewed the changes
   - [x] No new warnings generated
   - [x] Documentation updated (this IS the documentation update)
   


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: [email protected]

For queries about this service, please contact Infrastructure at:
[email protected]

Reply via email to