API v2 design

This is just a draft - some initial ideas how API can be improved

Nested resources

• appliance_type
  • /types/:id/port_mappings
  • /types/:id/http_mappings/:iid/endpoints
  • /types/:id/configs
  • /types/:id/vmts
• appliance_set
  • /sets/:id/appliances/:iid/port_mappings
  • /sets/:id/appliances/:iid/http_mappings/:iid/endpoints
  • /sets/:id/appliances/:iid/vms
• user_key
• compute_site

Json API like

Possible multi-level includes

• /appliance_types?includes=port_maping_templates,port_maping_templates.endpoints,configuration_templates

Resources:

• appliance_type, port_mapping_template, endpoint, configuration_template
• appliance_set, appliance, port_mapping, http_mapping, endpoint
• user, user_key
• compute_site, virtual_machine, virtual_machine_template

Notes

• dev_mode_property_set hidden from the user
• configuration_instance is embedded into appliance