[Tendrl-devel] REST API consistency

[Martin Kudlej]

Hi all,

I would like to ask if there is any movement in this area?

On 04/26/2017 09:58 AM, Martin Kudlej wrote:
> Hi all,
> 
> I think there is still time to unify Tendrl API functions according some rules.
> I've filed https://github.com/Tendrl/documentation/issues/70 couple of months ago without response.
> 
> One example for all.
> There are these functions for Ceph cluster(Flows on cluster):
>      "name": "CephCreatePool",
>      "method": "POST",
> 
>      "name": "CephCreateECProfile",
>      "method": "POST",
> 
>      "name": "CephDeleteECProfile",
>      "method": "DELETE",
> 
>      "name": "CephCreateRbd",
>      "method": "POST",
> 
>      "name": "CephDeleteRbd",
>      "method": "DELETE",
> 
>      "name": "CephResizeRbd",
>      "method": "PUT",
> 
>      "name": "CephDeletePool",
>      "method": "DELETE",
> 
>      "name": "CephUpdatePool",
>      "method": "PUT",
> 
> and according documentation there should be also
>      "name": "CephPoolList"
>      "method": "GET"
> 
> I think that there should be also "GET" "CephPool" because of performance.
> 
> I think that these functions should be transformed avoiding verb duplicity. Also I believe if API 
> function names are renamed integration with other projects will be much easier.
> 
> Pool CRUD
>      "name": ":ceph_cluster_id:/pool",
>      "method": "POST",
> 
>      "name": ":ceph_cluster_id:/pool/:ceph_pool_id:",
>      "method": "GET",
> 
>      "name": ":ceph_cluster_id:/pool/:ceph_pool_id:",
>      "method": "PUT",
> 
>      "name": ":ceph_cluster_id:/pool/:ceph_pool_id:",
>      "method": "DELETE",
> 
> RBD CRUD
> 
>      "name": ":ceph_cluster_id:/rbd",
>      "method": "POST",
> 
>      "name": ":ceph_cluster_id:/rbd/:ceph_pool_id:",
>      "method": "GET",
> 
>      "name": ":ceph_cluster_id:/rbd/:ceph_pool_id:",
>      "method": "PUT",
> 
>      "name": ":ceph_cluster_id:/rbd/:ceph_pool_id:",
>      "method": "DELETE",
> 
> EC Profile CRUD
> 
>      "name": ":ceph_cluster_id:/ecprofile",
>      "method": "POST",
> 
>      "name": ":ceph_cluster_id:/ecprofile/:ec_profile_id:",
>      "method": "GET",
> 
> (update if it is possible)
>      "name": ":ceph_cluster_id:/ecprofile/:ec_profile_id:",
>      "method": "PUT",
> 
>      "name": ":ceph_cluster_id:/ecprofile/:ec_profile_id:",
>      "method": "DELETE",
> 
> 
> Lists
> 
>      "name": ":ceph_cluster_id:/pool"
>      "method": "GET"
> 
>      "name": ":ceph_cluster_id:/rbd"
>      "method": "GET"
> 
>      "name": ":ceph_cluster_id:/ecprofile"
>      "method": "GET"
> 
> Please consider this rename until is not too late and there are not many projects which are 
> integrated with Tendrl.
> 

-- 
Best Regards,
Martin Kudlej.
RHSC/USM Senior Quality Assurance Engineer
Red Hat Czech s.r.o.

Phone: +420 532 294 155
E-mail:mkudlej at redhat.com
IRC:   mkudlej at #brno, #gluster, #storage-qa, #rhs, #rh-ceph, #usm-meeting @ redhat
                   #tendrl-devel @ freenode