Bug 1038691 - Rest: rsdl expected response body is missing for all calls
Summary: Rest: rsdl expected response body is missing for all calls
Keywords:
Status: CLOSED WONTFIX
Alias: None
Product: Red Hat Gluster Storage
Classification: Red Hat Storage
Component: rhsc-sdk
Version: 2.1
Hardware: Unspecified
OS: Unspecified
low
low
Target Milestone: ---
: ---
Assignee: Shubhendu Tripathi
QA Contact: Mike McCune
URL:
Whiteboard:
Depends On:
Blocks: 1035040
TreeView+ depends on / blocked
 
Reported: 2013-12-05 16:00 UTC by Dustin Tsang
Modified: 2015-08-31 10:07 UTC (History)
4 users (show)

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.
Clone Of:
Environment:
Last Closed: 2015-08-31 10:07:49 UTC
Embargoed:


Attachments (Terms of Use)
screenshot (53.38 KB, image/png)
2013-12-06 13:59 UTC, Dustin Tsang
no flags Details

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


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