Bug 827523

Summary: REST API: Explicitly state units used for memory element of virtual machine
Product: Red Hat Enterprise Virtualization Manager Reporter: Stephen Gordon <sgordon>
Component: DocumentationAssignee: Dan Macpherson <dmacpher>
Status: CLOSED CURRENTRELEASE QA Contact: ecs-bugs
Severity: unspecified Docs Contact:
Priority: unspecified    
Version: 3.1.0CC: acathrow, dyasny, gklein, mpastern, sgordon, yeylon
Target Milestone: ---Keywords: Documentation
Target Release: ---   
Hardware: Unspecified   
OS: Unspecified   
Whiteboard:
Fixed In Version: Doc Type: Bug Fix
Doc Text:
Story Points: ---
Clone Of: Environment:
Last Closed: 2012-12-04 17:24:27 UTC Type: Bug
Regression: --- Mount Type: ---
Documentation: --- CRM:
Verified Versions: Category: ---
oVirt Team: --- RHEL 7.3 requirements from Atomic Host:
Cloudforms Team: --- Target Upstream Version:
Embargoed:

Description Stephen Gordon 2012-06-01 17:24:26 UTC 
Description of problem:

Section "3.11. Create Virtual Machine states "The request also defines the virtual machine's memory as 512 MB and sets the boot device to a virtual hard disk.". The following example then specifies the memory in bytes, as required by the API.

The lead-in text should:
- Explicitly state the requirement to convert the desired amount of RAM to bytes.
- Provide the conversion formula (emphasising 1024 * 1024 * M rather than 1000 * 1000 * M).

There may be other API examples relating to virtual machines that need similar treatment.

http://docs.redhat.com/docs/en-US/Red_Hat_Enterprise_Virtualization/3.0/html/REST_API_Guide/sect-REST_API_Guide-Example-Create_VM.html

Additionally the memory entry in Table 13.1. Virtual machine elements should also refer to the formula.

http://docs.redhat.com/docs/en-US/Red_Hat_Enterprise_Virtualization/3.0/html/REST_API_Guide/chap-REST_API_Guide-VMs.html

Version-Release number of selected component (if applicable):

3.0, 3.1
Comment 1 Dan Macpherson 2012-08-01 16:21:08 UTC 
* Added two notes for each VM example that uses bytes (create, update) that states the values have been converted to bytes using the formula.
* VM elements explicitly states the requirement for bytes, but I don't think the formula is necessary in that instance.
Committed revision 83855.