Bug 1317022

Summary: add to the documentation an exemple of openstack deployment through REST api
Product: Red Hat CloudForms Management Engine Reporter: Felix Dewaleyne <fdewaley>
Component: DocumentationAssignee: Red Hat CloudForms Documentation <cloudforms-docs>
Status: CLOSED WONTFIX QA Contact: Red Hat CloudForms Documentation <cloudforms-docs>
Severity: medium Docs Contact:
Priority: unspecified    
Version: 5.5.0CC: adahms, fdewaley, jhardy, mfeifer, nachandr, obarenbo
Target Milestone: GA   
Target Release: cfme-future   
Hardware: All   
OS: All   
Whiteboard: doc
Fixed In Version: Doc Type: Bug Fix
Doc Text:
Story Points: ---
Clone Of: Environment:
Last Closed: 2018-10-08 23:33:31 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:
Bug Depends On: 1297335, 1335471    
Bug Blocks:    

Description Felix Dewaleyne 2016-03-11 17:42:16 UTC 
Description of problem:
as raised in a customer case attached to this ticket, we do not include enough exemples in document https://access.redhat.com/documentation/en/red-hat-cloudforms/version-4.0/red-hat-cloudforms-rest-api/#sect_provisioning_requests

we should include more details about the possible values or guidance on where and how the person reading the document can find and build the query depending their needs.

Document URL: https://access.redhat.com/documentation/en/red-hat-cloudforms/version-4.0/red-hat-cloudforms-rest-api/#sect_provisioning_requests

Section Number and Name: 3.5 - provision requests

Describe the issue: 

 - not all elements used in cloudforms are listed there and there ; there is no mention that other elements and how to find out some values have to be passed in some way (e.g. cloud_networks for openstack).

Suggestions for improvement: 

amend the documentation to mention that not all elements are listed and give general guidance to locate a value and how to provide it in the api call

Additional information:
Comment 3 Andrew Dahms 2018-10-08 23:33:31 UTC 
Thank you for raising this bug.

We have evaluated this request, and while we recognize that it is a valid request for the documentation, we do not expect this to be implemented in the product in the foreseeable future. We are therefore closing this out as WONTFIX. 

If you have any concerns about this, please feel free to contact Andrew Dahms.