Bug 1298114

Summary: full documentation of skyring REST API including basic examples
Product: [Red Hat Storage] Red Hat Storage Console Reporter: Martin Kudlej <mkudlej>
Component: coreAssignee: Nishanth Thomas <nthomas>
Status: CLOSED WONTFIX QA Contact: sds-qe-bugs
Severity: high Docs Contact:
Priority: unspecified    
Version: 2CC: khartsoe, mbukatov, nthomas, sankarshan
Target Milestone: ---Keywords: Reopened
Target Release: 3   
Hardware: Unspecified   
OS: Unspecified   
Whiteboard:
Fixed In Version: Doc Type: Bug Fix
Doc Text:
Story Points: ---
Clone Of: Environment:
Last Closed: 2017-03-23 04:05:09 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: 1339605    
Bug Blocks: 1312404    

Description Martin Kudlej 2016-01-13 09:51:32 UTC 
Description of problem:
I think that REST API should be built according some rules. I've found good example of rules which can be reused and extended/modified for RHSCon:
https://github.com/ManageIQ/manageiq_docs/blob/master/api/overview/http.adoc

Similar specification for authentication:
https://github.com/ManageIQ/manageiq_docs/blob/master/api/overview/auth.adoc

I think that rules for RHSCon should be also documented in documentation.
Comment 3 Martin Kudlej 2016-04-22 10:35:13 UTC 
I still think that for example return codes should be unified among all functions in API. But we can only document rules according API is built. --> documentation
Comment 4 Martin Bukatovic 2016-05-25 12:26:53 UTC 
Moving to core component, because the API documentation needs to be part of
upstream repository directly written by developers. Anjana is not going to
fully document the API including few basic examples based on the source code.
Comment 5 Martin Bukatovic 2016-05-25 12:29:17 UTC 
Upstream issue: https://github.com/skyrings/skyring/issues/13