Red Hat Bugzilla – Bug 1298114
full documentation of skyring REST API including basic examples
Last modified: 2017-03-23 00:05:09 EDT
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:
Similar specification for authentication:
I think that rules for RHSCon should be also documented in documentation.
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
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.
Upstream issue: https://github.com/skyrings/skyring/issues/13