Skip to content

Update API documentation for resizing#6556

Merged
yadvr merged 1 commit intoapache:mainfrom
Rubueno:apiexplain
Jul 20, 2022
Merged

Update API documentation for resizing#6556
yadvr merged 1 commit intoapache:mainfrom
Rubueno:apiexplain

Conversation

@Rubueno
Copy link
Copy Markdown
Contributor

@Rubueno Rubueno commented Jul 19, 2022 •
edited
Loading

Description

This PR...
Updates API documentation regarding resizing commands. It informs the user of the actually needed parameters.

Types of changes

  • Breaking change (fix or feature that would cause existing functionality to change)
  • New feature (non-breaking change which adds functionality)
  • Bug fix (non-breaking change which fixes an issue)
  • Enhancement (improves an existing feature and functionality)
  • Cleanup (Code refactoring and cleanup, that may add test cases)

Feature/Enhancement Scale or Bug Severity

Feature/Enhancement Scale

  • Major
  • Minor

Bug Severity

  • BLOCKER
  • Critical
  • Major
  • Minor
  • Trivial

How Has This Been Tested?

(localcloud) 🐱 > change serviceforvirtualmachine id=5568b625-0012-429c-82b4-da3e177e166e serviceofferingid=b4b7e9ca-45cd-4c8e-b9d8-0c7ff0f79fc2 details[0].cpu=2 details[1].cpuspeed=2000 details[2].ram=1024
🙈 Error: (HTTP 431, error code 4350) Invalid cpu cores value, specify a value between 1 and 2147483647

change serviceforvirtualmachine id=5568b625-0012-429c-82b4-da3e177e166e serviceofferingid=b4b7e9ca-45cd-4c8e-b9d8-0c7ff0f79fc2 details[0].cpunumber=2 details[0].cpuspeed=2000 details[0].memory=1024

@boring-cyborg
Copy link
Copy Markdown

boring-cyborg bot commented Jul 19, 2022

Congratulations on your first Pull Request and welcome to the Apache CloudStack community! If you have any issues or are unsure about any anything please check our Contribution Guide (https://github.com/apache/cloudstack/blob/main/CONTRIBUTING.md)
Here are some useful points:

GabrielBrascher
GabrielBrascher approved these changes Jul 19, 2022
View reviewed changes
Copy link
Copy Markdown
Member

@GabrielBrascher GabrielBrascher left a comment •
edited
Loading

Choose a reason for hiding this comment

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

Thanks for the PR @Rubueno.
LGTM, it makes sense to explicitly document it as cpuspeed, as it would fail if passed just as cpu.

@Rubueno
Update API documentation for resizing
efe9c92 
The correct parameter is `cpuspeed` and not `cpu`. This led me to some
confusion when resizing a VM attached to an offering allowing custom
values.
@sonarqubecloud
Copy link
Copy Markdown

sonarqubecloud bot commented Jul 19, 2022

Kudos, SonarCloud Quality Gate passed!    Quality Gate passed

Bug A 0 Bugs
Vulnerability A 0 Vulnerabilities
Security Hotspot A 0 Security Hotspots
Code Smell A 0 Code Smells

No Coverage information No Coverage information
50.0% 50.0% Duplication

@yadvr yadvr merged commit 3bedddb into apache:main Jul 20, 2022
@boring-cyborg
Copy link
Copy Markdown

boring-cyborg bot commented Jul 20, 2022

Awesome work, congrats on your first merged pull request!

@yadvr yadvr added this to the 4.18.0.0 milestone Jul 20, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@yadvr yadvr yadvr approved these changes

@harikrishna-patnala harikrishna-patnala harikrishna-patnala approved these changes

@GabrielBrascher GabrielBrascher GabrielBrascher approved these changes

@sureshanaparti sureshanaparti sureshanaparti approved these changes

Assignees

No one assigned

Labels

component:api component:documentation

Projects

None yet

Milestone

4.18.0.0

Development

Successfully merging this pull request may close these issues.

5 participants

@Rubueno @yadvr @harikrishna-patnala @GabrielBrascher @sureshanaparti