V2 Manager API

[damies13]

This issue is to track the design and documentation of the V2 Manager API

The goal is fro the V2 Manager API to be to a real REST API

The V2 API needs to:

• provide the functionality that the V1 API currently provides, but in a more planned logical way
• provide API endpoints to read/update settings
• provide API endpoints to read data for display in the UI (including graph windows)

Initial thoughts would be (all below would be under /api/v2):

• /scenario - everything related to the test plan
  • /scenario/settings
  • /scenario/plan/
  • /scenario/monitoring/
• /agent - agent registration and communication
  • /agent/jobs
• /jobs - list all job id's
  • /jobs/<job_id> - job details
• /result - read/write all result related info
• /metric - read/write all metric related info

[damies13]

The UI components (responds with HTML / JS / CSS etc would all be under /ui

requests to / or /index.html will redirect to /ui/index.html (http 301 moved permanently)

The path /api/v1 will contain v1.x api calls for compatibility with V1 agents, will be deprecated in V2.1 and removed in v2.2 (I could leave it longer if requested)