Bug 1377738 - [Docs][REST] Wrong example format in hot plugging vCPUs api example
Summary: [Docs][REST] Wrong example format in hot plugging vCPUs api example
Keywords:
Status: CLOSED CURRENTRELEASE
Alias: None
Product: Red Hat Enterprise Virtualization Manager
Classification: Red Hat
Component: Documentation
Version: unspecified
Hardware: Unspecified
OS: Unspecified
high
unspecified
Target Milestone: ovirt-3.6.10
: ---
Assignee: Byron Gravenorst
QA Contact: Megan Lewis
URL:
Whiteboard:
Depends On:
Blocks:
TreeView+ depends on / blocked
 
Reported: 2016-09-20 13:48 UTC by Jenny Tokar
Modified: 2016-12-21 03:37 UTC (History)
7 users (show)

Fixed In Version:
Doc Type: If docs needed, set a value
Doc Text:
Clone Of:
Environment:
Last Closed: 2016-12-21 03:37:37 UTC
oVirt Team: Docs
Target Upstream Version:
Embargoed:


Attachments (Terms of Use)

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.


Note You need to log in before you can comment on or make changes to this bug.