Bug 1038691 – Rest: rsdl expected response body is missing for all calls

Bugzilla will be upgraded to version 5.0. The upgrade date is tentatively scheduled for 2 December 2018, pending final testing and feedback.

Bug 1038691 - Rest: rsdl expected response body is missing for all calls

Summary:	Rest: rsdl expected response body is missing for all calls

Status:	CLOSED WONTFIX

Aliases:	None

Product:	Red Hat Gluster Storage
Classification:	Red Hat
Component:	rhsc-sdk (Show other bugs)
Sub Component:
Version:	2.1
Hardware:	Unspecified Unspecified

Priority	low Severity low
Target Milestone:	---
Target Release:	---
Assigned To:	Shubhendu Tripathi
QA Contact:	Mike McCune
Docs Contact:

URL:
Whiteboard:
Keywords:

Depends On:
Blocks:	1035040
	Show dependency tree / graph

Reported:	2013-12-05 11:00 EST by Dustin Tsang
Modified:	2015-08-31 06:07 EDT (History)
CC List:	4 users (show)

See Also:
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 06:07:49 EDT
Type:	Bug
Regression:	---
Mount Type:	---
Documentation:	---
CRM:
Verified Versions:
Category:	---
oVirt Team:	---
RHEL 7.3 requirements from Atomic Host:
Cloudforms Team:	---

Attachments	(Terms of Use)
screenshot (53.38 KB, image/png) 2013-12-06 08:59 EST, Dustin Tsang	no flags	Details
Add an attachment (proposed patch, testcase, etc.)

Groups: None (edit)

Description Dustin Tsang 2013-12-05 11:00:28 EST

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 03:49:34 EST

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 08:58:15 EST

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 08:59:14 EST

Created attachment 833618 [details]
screenshot

Comment 5 Dusmant 2013-12-10 05:41:37 EST

The schema has all the details of each type and that should suffice...

Comment 6 Dusmant 2013-12-10 11:58:27 EST

We need to release note this bug... with all the schema related details.

Comment 7 Shalaka 2014-01-29 01:33:03 EST

Please review the edited Doc Text and sign off.

Comment 8 Shubhendu Tripathi 2014-01-29 05:10:33 EST

doc text looks fine

Comment 11 Dusmant 2015-08-31 06:07:49 EDT

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.