Bug 1038691

Summary: Rest: rsdl expected response body is missing for all calls
Product: [Red Hat Storage] Red Hat Gluster Storage Reporter: Dustin Tsang <dtsang>
Component: rhsc-sdkAssignee: Shubhendu Tripathi <shtripat>
Status: CLOSED WONTFIX QA Contact: Mike McCune <mmccune>
Severity: low Docs Contact:
Priority: low    
Version: 2.1CC: asriram, dpati, mmccune, rhs-bugs
Target Milestone: ---   
Target Release: ---   
Hardware: Unspecified   
OS: Unspecified   
Whiteboard:
Fixed In Version: Doc Type: Known Issue
Doc Text:
The RESTful Service Description Language (RSDL) file displays only the response type and not the detailed view of the response elements. Workaround: Refer the URL/API schema for detailed view of the elements of response type for the actions.
 Story Points: ---
Clone Of: Environment:
Last Closed: 2015-08-31 10:07:49 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: 1035040    
Attachments:
Description Flags
screenshot none

Description Dustin Tsang 2013-12-05 16:00:28 UTC 
Description of problem:
Currently Rsdl only shows the response type and does not show the expected fields returned to user in a response.
 
For example in the Host create action this is the response:
<link href="/api/hosts" rel="add">
...
...
<response>
  <type>Host</type>
</response>
</link>

Version-Release number of selected component (if applicable):
rhsc-cb10
Comment 2 Dusmant 2013-12-06 08:49:34 UTC 
Pls. add the screen shots of the steps taken and the actual resutl screen shot. Otherwise, it's kind of difficult to figure out the problem...

Pls. add the expected result also, so that it's clear.
Comment 3 Dustin Tsang 2013-12-06 13:58:15 UTC 
Steps
1. go to the rsdl https://<rhsc host>/api?rsdl

actual result:
 observe for each link > response, that there are no parameters present.

expected result:
 there should be expected fields listed for each link's response.
Comment 4 Dustin Tsang 2013-12-06 13:59:14 UTC 
Created attachment 833618 [details]
screenshot
Comment 5 Dusmant 2013-12-10 10:41:37 UTC 
The schema has all the details of each type and that should suffice...
Comment 6 Dusmant 2013-12-10 16:58:27 UTC 
We need to release note this bug... with all the schema related details.
Comment 7 Shalaka 2014-01-29 06:33:03 UTC 
Please review the edited Doc Text and sign off.
Comment 8 Shubhendu Tripathi 2014-01-29 10:10:33 UTC 
doc text looks fine
Comment 11 Dusmant 2015-08-31 10:07:49 UTC 
We are not planning to fix it. Hence closing this BZ. If you think, it's applicable for 3.x release and would have an impact on customer, pls. open up a new BZ with the appropriate version. Thanks, -Dusmant