Bug 1139266

(In reply to Philipp Gassmann from comment #0)
> Title: RHEV REST API Documentation not up to date
> 
> Describe the issue:
> During the implementaion of Puppet Providers for RHEV that uses its REST api
> I came across some inacuracies in the documentation.
> 
> - Datacenter API:
> There's no need to specify storage type in 3.4. Only local => true/false is
> required. Also the output of GET is not up-to-date.
> https://access.redhat.com/documentation/en-US/
> Red_Hat_Enterprise_Virtualization/3.4/html/Technical_Guide/
> Example_List_Data_Center_Collection.html
> actual output:
> <data_centers>
>     <data_center
> href="/api/datacenters/00000002-0002-0002-0002-000000000000"
> id="00000002-0002-0002-0002-000000000000">
>         <name>Default</name>
>         <description>The default Data Center</description>
>         <link
> href="/api/datacenters/00000002-0002-0002-0002-000000000000/storagedomains"
> rel="storagedomains"/>
>         <link
> href="/api/datacenters/00000002-0002-0002-0002-000000000000/clusters"
> rel="clusters"/>
>         <link
> href="/api/datacenters/00000002-0002-0002-0002-000000000000/networks"
> rel="networks"/>
>         <link
> href="/api/datacenters/00000002-0002-0002-0002-000000000000/permissions"
> rel="permissions"/>
>         <link
> href="/api/datacenters/00000002-0002-0002-0002-000000000000/quotas"
> rel="quotas"/>
>         <local>false</local>
>         <version major="3" minor="4"/>
>         <supported_versions>
>             <version major="3" minor="4"/>
>         </supported_versions>
>         <status>
>             <state>uninitialized</state>
>         </status>
>     </data_center>
> </data_centers>
> 
> 
> Similar
> https://access.redhat.com/documentation/en-US/
> Red_Hat_Enterprise_Virtualization/3.4/html/Technical_Guide/sect-Methods.html
> requires now:
> <data_center>
>   <name>#{name}</name>
>   <local>#{local}</local>
>   <version major=\"#{version_maj}\" minor=\"#{version_min}\"/>
>   <description>#{description}</description>
> </data_center>
> 
> 
> Additional information:
> Creation of a datacenter with a storage_type as in the current documentation
> still works too, but the storage type can't be queried.
Hi Philipp,
    Thanks for filing this bug. This bug has been assigned and is currently work in progress.

Cheers,
Julie

Thanks for the feedback, Philipp.
I've updated the 'Example: List Data Center Collection', 'Data Center Elements', and the example 'Creating a New Data Center' topics to match reality. 

I'll post the 3.4 and 3.5 documentation links when these books are next published. 

Thanks again,
Andrew


Internal:
ID 7641-716349
   7965-716362
   7729-716366

Documentation Link
------------------------------
1) http://documentation-devel.engineering.redhat.com/site/documentation/en-US/Red_Hat_Enterprise_Virtualization/3.5/html/Technical_Guide/Example_List_Data_Center_Collection.html (3.5)

http://documentation-devel.engineering.redhat.com/site/documentation/en-US/Red_Hat_Enterprise_Virtualization/3.4/html/Technical_Guide/Example_List_Data_Center_Collection.html (3.4)

2) http://documentation-devel.engineering.redhat.com/site/documentation/en-US/Red_Hat_Enterprise_Virtualization/3.5/html/Technical_Guide/chap-Data_Centers.html#Data_Center_Elements

3) http://documentation-devel.engineering.redhat.com/site/documentation/en-US/Red_Hat_Enterprise_Virtualization/3.5/html/Technical_Guide/sect-Methods2.html#Creating_a_New_Data_Center1


What Changed 
------------------------------
1) Updated the output for 3.5
Example: List Data Center Collection [7641-716398]
   Updated the output for 3.4
Example: List Data Center Collection [7641-716349]

2) 'local' is no longer read-only, but is now required for creation. Conversely, 'storage_format' and 'version' are no longer required for creation.
Data Center Elements [7965-716362]

3) Removed two elements no longer inherently necessary for DC creation, and added 'local' as it now is necessary for DC creation.
Creating a New Data Center [7729-716366]

Updated revision history: [34616-716400] (3.5)
Updated revision history: [30107-716402] (3.4)
716402


Versions Applicable: 3.5, 3.4


NVR
------------------------------
Red_Hat_Enterprise_Virtualization-Technical_Guide-3.5-web-en-US-3.5-19.el6eng
Red_Hat_Enterprise_Virtualization-Technical_Guide-3.4-web-en-US-3.4-20.el6eng