Note: This bug is displayed in read-only format because the product is no longer active in Red Hat Bugzilla.

Bug 1377738

Summary: [Docs][REST] Wrong example format in hot plugging vCPUs api example
Product: Red Hat Enterprise Virtualization Manager Reporter: Jenny Tokar <jtokar>
Component: DocumentationAssignee: Byron Gravenorst <bgraveno>
Status: CLOSED CURRENTRELEASE QA Contact: Megan Lewis <melewis>
Severity: unspecified Docs Contact:
Priority: high    
Version: unspecifiedCC: gklein, lbopf, lsurette, rbalakri, srevivo, ykaul, ylavi
Target Milestone: ovirt-3.6.10   
Target Release: ---   
Hardware: Unspecified   
OS: Unspecified   
Whiteboard:
Fixed In Version: Doc Type: If docs needed, set a value
Doc Text:
Story Points: ---
Clone Of: Environment:
Last Closed: 2016-12-21 03:37:37 UTC Type: Bug
Regression: --- Mount Type: ---
Documentation: --- CRM:
Verified Versions: Category: ---
oVirt Team: Docs RHEL 7.3 requirements from Atomic Host:
Cloudforms Team: --- Target Upstream Version:
Embargoed:

Description Jenny Tokar 2016-09-20 13:48:53 UTC 
Description of problem:

The example stated in the doc (https://access.redhat.com/documentation/en-US/Red_Hat_Enterprise_Virtualization/3.6/html/REST_API_Guide/sect-Methods7.html#Updating_a_Virtual_Machine section 15.7) is in a wrong format and if someone will use it he will not get the expected results. 

The wrong example: 
<vm>
    <cpu>
        <topology sockets="2" cores="1"/>
    </cpu>
</vm>

The correct example:
    <vm>
        <cpu>
          <topology>
            <sockets>4</sockets>
            <cores>2</cores>
            <threads>2</threads>
          </topology>
        </cpu>
     </vm>

If a user will try and run the api with the example from the docs the vm topology will not change.
Comment 1 Lucy Bopf 2016-11-18 01:17:48 UTC 
Assigning to Byron for review.
Comment 4 Byron Gravenorst 2016-12-21 03:37:37 UTC 
This content has been published to:

https://access.redhat.com/documentation/en-US/Red_Hat_Enterprise_Virtualization/3.6/html-single/REST_API_Guide/index.html#Updating_a_Virtual_Machine