Bug 1201228 - Wrong 'storage_domain_state' element listed in REST API documentation for storage domains
Summary: Wrong 'storage_domain_state' element listed in REST API documentation for sto...
Keywords:
Status: CLOSED CURRENTRELEASE
Alias: None
Product: Red Hat Enterprise Virtualization Manager
Classification: Red Hat
Component: Documentation
Version: 3.5.0
Hardware: Unspecified
OS: Unspecified
unspecified
unspecified
Target Milestone: ---
: ---
Assignee: Julie
QA Contact: Megan Lewis
URL:
Whiteboard:
Depends On:
Blocks: 1256971
TreeView+ depends on / blocked
 
Reported: 2015-03-12 11:22 UTC by Christophe Fergeau
Modified: 2015-10-20 10:24 UTC (History)
11 users (show)

Fixed In Version:
Doc Type: Bug Fix
Doc Text:
Clone Of:
Environment:
Last Closed: 2015-10-20 10:24:56 UTC
oVirt Team: ---
Target Upstream Version:
Embargoed:


Attachments (Terms of Use)

Description Christophe Fergeau 2015-03-12 11:22:39 UTC
The table at https://access.redhat.com/documentation/en-US/Red_Hat_Enterprise_Virtualization/3.5/html/Technical_Guide/chap-Storage_Domains.html lists a 'storage_domain_state' element in table 27.1. Storage domain elements

This <storage_domain_state> element does not exist in the XML of a storage domain, it's present in /api/capabilities to describe the valid states for a storage domain. The state is mapped in a storage domain XML through <status><state>. This is also consistent with the xsd schema describing storage domain XML.

Comment 1 Julie 2015-07-30 04:32:37 UTC
(In reply to Christophe Fergeau from comment #0)
> The table at
> https://access.redhat.com/documentation/en-US/
> Red_Hat_Enterprise_Virtualization/3.5/html/Technical_Guide/chap-
> Storage_Domains.html lists a 'storage_domain_state' element in table 27.1.
> Storage domain elements
> 
> This <storage_domain_state> element does not exist in the XML of a storage
> domain, it's present in /api/capabilities to describe the valid states for a
> storage domain. The state is mapped in a storage domain XML through
> <status><state>. This is also consistent with the xsd schema describing
> storage domain XML.

Hi Christophe,
   Thanks for filing this bug. I will remove the storage_domain_state element from the table as it no longer exists. 
You also mentioned the <status><state> element. I wasn't able to find it. Could you clarify how I can check a domain's status through API now?

Many thanks,
Julie

Comment 3 Christophe Fergeau 2015-07-30 06:56:55 UTC
If you have access to a RHEV/oVirt instance, you can connect to https://rhev.example.com/api/storagedomains (using 'admin' credentials) and check it this way. If you prefer an xsd schema, you would use https://rhev.example.com/api?schema

Comment 4 Julie 2015-07-30 07:27:58 UTC
(In reply to Christophe Fergeau from comment #3)
> If you have access to a RHEV/oVirt instance, you can connect to
> https://rhev.example.com/api/storagedomains (using 'admin' credentials) and
> check it this way. If you prefer an xsd schema, you would use
> https://rhev.example.com/api?schema

Thanks Chris for clarifying. This is covered in the opening paragraph:
"An API user accesses this information through the rel="storagedomains" link obtained from the entry point URI." 

Please let me know if you would like me to update anything else as part of this bug and feel free to file new bugs if you have more feedback for our docs.

Moving to docs QA.


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