Bug 1121975 - Wrong required parameters description in REST API documentation in section 7.3 GET /metric/data
Summary: Wrong required parameters description in REST API documentation in section 7....
Status: CLOSED CURRENTRELEASE
Alias: None
Product: RHQ Project
Classification: Other
Component: Documentation
Version: 4.13
Hardware: Unspecified
OS: Unspecified
unspecified
low vote
Target Milestone: ---
: RHQ 4.13
Assignee: Deon Ballard
QA Contact: Mike Foley
URL:
Whiteboard:
Keywords:
Depends On:
Blocks: 1121982
TreeView+ depends on / blocked
 
Reported: 2014-07-22 09:12 UTC by Jan Bednarik
Modified: 2016-02-24 17:37 UTC (History)
2 users (show)

(edit)
Clone Of:
(edit)
Last Closed: 2016-02-24 17:37:23 UTC


Attachments (Terms of Use)

Description Jan Bednarik 2014-07-22 09:12:26 UTC
Description of problem:
It is written in REST API documentation in section 7.3 GET /metric/data that the parameter "sid" is not required (Required = "false") even though this only parameter is required. If it is not specified in REST query the server responds with HTTP code 406.

https://access.redhat.com/documentation/en-US/Red_Hat_JBoss_Operations_Network/3.2/html/RestAPI/index.html#idp18308880

Version-Release number of selected component (if applicable):


How reproducible:


Steps to Reproduce:
1.
2.
3.

Actual results:


Expected results:


Additional info:

Comment 1 Heiko W. Rupp 2014-07-22 10:01:23 UTC
The parameter has been marked as required in master 21ce2d7182796 so that the next documentation generation run will have the correct description.

Comment 3 Deon Ballard 2016-02-24 17:37:23 UTC
Closing old ON_QA bugs. These have long since been published.


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