Re: Consistent Response structure for Stratos REST APIs

2014-07-12 Thread Udara Liyanage
I made changes so that Stratos REST API adhere to the HTTP specification. Given below are some of the examples. *GET * Header 200 with response body containing the data. Return 204 if no content found with the given url. *POST * POST - 201 Return 201 when the resource is created and URL to t

Re: Consistent Response structure for Stratos REST APIs

2014-07-08 Thread Isuru Haththotuwa
+1 for this change. We can use a standard way to do this, such as returning a 'Response' type [1]. [1]. http://docs.oracle.com/javaee/6/api/javax/ws/rs/core/Response.html On Tue, Jul 8, 2014 at 10:10 AM, Dakshika Jayathilaka wrote: > +1 for having proper back end error mechanism for end users

Re: Consistent Response structure for Stratos REST APIs

2014-07-07 Thread Dakshika Jayathilaka
+1 for having proper back end error mechanism for end users, but when we are designing it has to adhere some proper standard, coz this is community project and many contributors may take part on this. If we loosed the concepts on starting point that will deviate whole concept of having standardiza

Re: Consistent Response structure for Stratos REST APIs

2014-07-07 Thread Udara Liyanage
Hi Dakshita, I am really worried about the structure of the response rather than what values it should output. What I wanted to tell is every API call should send response adhering to that format regardless of the fields it has. For a REST client for Stratos, http status code is important in very

Re: Consistent Response structure for Stratos REST APIs

2014-07-07 Thread Dakshika Jayathilaka
There are some instances we need to have HTTP status + attribute details on body. ex: *409 conflict: *can return in different scenarios, so we need to implement some differentiation mechanism if you check HTTP/1.1[1] spec its clearly mention this: The response body SHOULD include enough informa

Re: Consistent Response structure for Stratos REST APIs

2014-07-07 Thread Imesh Gunaratne
Udara, there are few other important points: * Introduce versioning to the API and preserve v1.0 released with Stratos 4.0.0 for a certain time period. * introduce token based authentication. May be we could do these with separate tasks. Thanks On Monday, July 7, 2014, Imesh Gunaratne wrote

Re: Consistent Response structure for Stratos REST APIs

2014-07-07 Thread Imesh Gunaratne
+1 Definitely, we need to do this. Jsend spec looks good, but I wonder whether we need a status attribute since HTTP status code already does that. One other important fact is that we need to document the API definition very well with samples. Thanks On Monday, July 7, 2014, Udara Liyanage wro

Consistent Response structure for Stratos REST APIs

2014-07-07 Thread Udara Liyanage
HI, Currently different REST API methods sends response in different formats. Some API methods have Response as the return type and some have Response. IMO it is better if all the API methods fallow the same format. For instance [1] discuss a simple response format. [1] http://labs.omniti.com/lab