Bug 1298114 - full documentation of skyring REST API including basic examples
Summary: full documentation of skyring REST API including basic examples
Keywords:
Status: CLOSED WONTFIX
Alias: None
Product: Red Hat Storage Console
Classification: Red Hat Storage
Component: core
Version: 2
Hardware: Unspecified
OS: Unspecified
unspecified
high
Target Milestone: ---
: 3
Assignee: Nishanth Thomas
QA Contact: sds-qe-bugs
URL:
Whiteboard:
Depends On: 1339605
Blocks: 1312404
TreeView+ depends on / blocked
 
Reported: 2016-01-13 09:51 UTC by Martin Kudlej
Modified: 2017-03-23 04:05 UTC (History)
4 users (show)

Fixed In Version:
Doc Type: Bug Fix
Doc Text:
Clone Of:
Environment:
Last Closed: 2017-03-23 04:05:09 UTC
Embargoed:


Attachments (Terms of Use)


Links
System ID Private Priority Status Summary Last Updated
Red Hat Bugzilla 1328368 0 unspecified CLOSED [API] Inconsistent ERROR response to some GET */invalid-id and */not-existent-id requests 2021-02-22 00:41:40 UTC

Internal Links: 1328368

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


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