Re: [orion-dev] Site Configurations API now on the Wiki

[John Arthorne <John_Arthorne@xxxxxxxxxx>]

Hey Mark, sorry for the really late reply
here.

Overall this API      
 looks good. The only part that bothers me is the "other
actions" section. This is essentially an RPC API rather than a REST-oriented
API (execute some arbitrary command on a resource via POST). It seems like
this could instead be accomplished via a simple PUT on the site configuration
resource, since the "status" (started/stopped) is just a property
of that resource. I.e., you are not creating any resource here, but instead
just modifying the "status" property of a site configuration
resource. This start/stop operation is idempotent which makes it suitable
for PUT - for example trying to stop a site that is already stopped is
a harmless no-op.

john

Mark MacDonald/Ottawa/IBM@IBMCA
Sent by: orion-dev-bounces@xxxxxxxxxxx

03/05/2011 02:14 PM

Please respond to
Orion developer discussions <orion-dev@xxxxxxxxxxx>

To	orion-dev@xxxxxxxxxxx
cc
Subject	[orion-dev] Site Configurations API now on the Wiki

Hello everyone,

I've created a page on the Orion Wiki talking about the server REST API
for managing site configurations: http://wiki.eclipse.org/Orion/Server_API/Site_Configuration_API
This is a new feature targeted for M6.

If you have any comments about the API, please respond. I'm particularly
interested in making sure it fits in with our REST approach and resembles
the existing Orion APIs in its use of HTTP status codes, JSON representations,
etc.

Regards,
Mark_______________________________________________
orion-dev mailing list
orion-dev@xxxxxxxxxxx
http://dev.eclipse.org/mailman/listinfo/orion-dev