Improving and Finalizing Rest API Endpoints

[Isuru Haththotuwa <is...@wso2.com>]

Hi Devs,

The purpose of this thread is to do $subject.

Please find the currently supported Rest Operations along with the
endpoints. There is a lot of room for improvement, specially in naming the
resource paths uniformly. please share your thought on how appropriate the
current resource path names and any improvements. I have listed down more
appropriate endpoints for some operations.

   *Description*

*Current Endpoint*

*Proposed Endpoint*

Add a tenant

POST /admin/tenant


   Delete tenant

DELETE /admin/tenant/{tenantDomain}


   List tenants

GET /admin/tenant/list

GET /admin/tenant

Deploy cartridge definition

POST /admin/cartridge/definition/


   Remove a deployed cartridge definition

DELETE /admin/cartridge/definition/{cartridgeType}


   Deploy a partition definition

POST /admin/policy/deployment/partition

POST /admin/policy/partition

Deploy a autoscaling policy defintion

POST /admin/policy/autoscale


   Deploye a deployment policy definition

POST /admin/policy/deployment


   List partitions

GET /admin/partition


   List a particular partition

GET /admin/partition/{partitionId}


   List autoscaling policies

GET /admin/policy/autoscale


   List a particular autoscaling policy

GET /admin/policy/autoscale/{autoscalePolicyId}


   List deployment policies

GET /admin/policy/deployment


   List a particular deployment policy

GET /admin/policy/deployment/{deploymentPolicyId}


   List available single tenant cartridges

GET /admin/cartridge/list

GET /admin/cartridge/single-tenant

List available multi tenant cartridges

GET /admin/cartridge/tenanted/list

GET /admin/cartridge/multi-tenant

Subscribe to cartridge

POST /admin/cartridge/subscribe


   List subscriptions

GET /admin/cartridge/list/subscribed

GET /admin/subscription

Remove a subscription (unsubscribe)

POST /admin/cartridge/unsubscribe


 Note: alias for the subscription is given in the payload currently.

POST /admin/cartridge/unsubscribe/{subscription_alias}

Deploy multi-tenant service cluster

POST /admin/service/definition

POST admin/service/multi-tenant/cluster/definition

Undeploy multi-tenant service cluster

DELTE /admin/service/multi-tenant/cluster/definition/{serviceType}




Please note that more operations will be added to Rest API in future to
support many other functionalities.

-- 
Thanks and Regards,

Isuru H.
 +94 716 358 048* <http://wso2.com/>*