Bug 1201228
| Summary: | Wrong 'storage_domain_state' element listed in REST API documentation for storage domains | ||
|---|---|---|---|
| Product: | Red Hat Enterprise Virtualization Manager | Reporter: | Christophe Fergeau <cfergeau> |
| Component: | Documentation | Assignee: | Julie <juwu> |
| Status: | CLOSED CURRENTRELEASE | QA Contact: | Megan Lewis <melewis> |
| Severity: | unspecified | Docs Contact: | |
| Priority: | unspecified | ||
| Version: | 3.5.0 | CC: | adahms, amureini, cfergeau, ecohen, gklein, juwu, lsurette, rbalakri, tnisan, yeylon, ylavi |
| Target Milestone: | --- | ||
| Target Release: | --- | ||
| Hardware: | Unspecified | ||
| OS: | Unspecified | ||
| Whiteboard: | |||
| Fixed In Version: | Doc Type: | Bug Fix | |
| Doc Text: | Story Points: | --- | |
| Clone Of: | Environment: | ||
| Last Closed: | 2015-10-20 10:24:56 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: | |||
| Bug Depends On: | |||
| Bug Blocks: | 1256971 | ||
|
Description
Christophe Fergeau
2015-03-12 11:22:39 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 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 (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. |