RESTful regions

we are currently trying to figure out what the best approach for a REST “API” for regions is and would like to solicit comments :-)

currently the idea is to have a scheme as follows:

  • http://opensim.foobar.org:9000/admin/regions —
    • GET returns an array of (UUID, name, x location, y location, region’s REST URL)
    • POST would create a region
  • http://opensim.foobar.org:9000/admin/regions/4b787c46-1e3c-40ae-9494-2c924428f8e5/
  • GET would return detailed information about region
  • DELETE would delete region
  • PUT would update region information
  • http://opensim.foobar.org:9000/admin/regions/4b787c46-1e3c-40ae-9494-2c924428f8e5/name
    • GET would return name of region
    • PUT would update name of region
    • (similar for other region attributes if it makes sense)

current planning is to have this as an ApplicationPlugin level set of RestPlugins. an alternative would be to use region modules plus an ApplicationPlugin (for GET/POST on /admin/regions).

this applies to region (meta) data. the next question would be how to structure this for avatar information and also for stuff like inventory: something along the lines below?

  • http://opensim.foobar.org/admin/avatars
    • GET returns list of known avatars?
    • POST creates account?
  • http://opensim.foobar.org/admin/avatars/430f1da7-0e35-4c0f-985d-15046c077967/
    • GET returns detailed information about avatar?
    • PUT updates?
    • DELETE deletes?
  • http://opensim.foobar.org/admin/avatars/430f1da7-0e35-4c0f-985d-15046c077967/inventory/
    • GET returns inventory listing?
    • POST adds items to inventory?
    • DELETE deletes inventory items?