Update API routes in Developer Guide

Add  API v2 routes in doc.

Change-Id: I9586b524bf4c8f13a6bab071ef22d00b17ee321f
This commit is contained in:
Cai Hui 2018-11-12 05:01:30 -05:00 committed by Carl Caihui
parent 370009349f
commit eb5a0fe31d
1 changed files with 79 additions and 11 deletions

View File

@ -7,10 +7,11 @@ General
.. code-block:: rest
GET / List API version
GET /v1 JSON Home document, see https://tools.ietf.org/html/draft-nottingham-json-home-03
GET /v1 JSON Home document, see https://tools.ietf.org/html/draft-nottingham-json-home-03, v1 API
GET /v2 JSON Home document, v2 API
Backup metadata
---------------
Backup metadata(v1)
-------------------
.. code-block:: rest
@ -20,8 +21,8 @@ Backup metadata
GET /v1/backups/{backup_id} Get backup details
DELETE /v1/backups/{backup_id} Deletes the specified backup
Freezer clients management
--------------------------
Freezer clients management(v1)
------------------------------
.. code-block:: rest
@ -32,8 +33,8 @@ Freezer clients management
UPDATE /v1/clients/{freezerc_id} Updates the specified client information
DELETE /v1/clients/{freezerc_id} Deletes the specified client information
Freezer jobs management
-----------------------
Freezer jobs management(v1)
---------------------------
.. code-block:: rest
@ -45,8 +46,8 @@ Freezer jobs management
DELETE /v1/jobs/{jobs_id} Deletes the specified job information
PATCH /v1/jobs/{jobs_id} Updates part of the document
Freezer actions management
--------------------------
Freezer actions management(v1)
------------------------------
.. code-block:: rest
@ -58,8 +59,8 @@ Freezer actions management
DELETE /v1/actions/{actions_id} Deletes the specified action information
PATCH /v1/actions/{actions_id} Updates part of the action document
Freezer sessions management
---------------------------
Freezer sessions management(v1)
-------------------------------
.. code-block:: rest
@ -75,3 +76,70 @@ Freezer sessions management
PUT /v1/sessions/{sessions_id}/jobs/{job_id} adds the job to the session
DELETE /v1/sessions/{sessions_id}/jobs/{job_id} adds the job to the session
Backup metadata(v2)
-------------------
.. code-block:: rest
GET /v2/{project_id}/backups(?limit,offset) Lists backups
POST /v2/{project_id}/backups Creates backup entry
GET /v2/{project_id}/backups/{backup_id} Get backup details
DELETE /v2/{project_id}/backups/{backup_id} Deletes the specified backup
Freezer clients management(v2)
------------------------------
.. code-block:: rest
GET /v2/{project_id}/clients(?limit,offset) Lists registered clients
POST /v2/{project_id}/clients Creates client entry
GET /v2/{project_id}/clients/{freezerc_id} Get client details
UPDATE /v2/{project_id}/clients/{freezerc_id} Updates the specified client information
DELETE /v2/{project_id}/clients/{freezerc_id} Deletes the specified client information
Freezer jobs management(v2)
---------------------------
.. code-block:: rest
GET /v2/{project_id}/jobs(?limit,offset) Lists registered jobs
POST /v2/{project_id}/jobs Creates job entry
GET /v2/{project_id}/jobs/{jobs_id} Get job details
POST /v2/{project_id}/jobs/{jobs_id} creates or replaces a job entry using the specified job_id
DELETE /v2/{project_id}/jobs/{jobs_id} Deletes the specified job information
PATCH /v2/{project_id}/jobs/{jobs_id} Updates part of the document
Freezer actions management(v2)
------------------------------
.. code-block:: rest
GET /v2/{project_id}/actions(?limit,offset) Lists registered action
POST /v2/{project_id}/actions Creates action entry
GET /v2/{project_id}/actions/{actions_id} Get action details
POST /v2/{project_id}/actions/{actions_id} creates or replaces a action entry using the specified action_id
DELETE /v2/{project_id}/actions/{actions_id} Deletes the specified action information
PATCH /v2/{project_id}/actions/{actions_id} Updates part of the action document
Freezer sessions management(v2)
-------------------------------
.. code-block:: rest
GET /v2/{project_id}/sessions(?limit,offset) Lists registered session
POST /v2/{project_id}/sessions Creates session entry
GET /v2/{project_id}/sessions/{sessions_id} Get session details
POST /v2/{project_id}/sessions/{sessions_id} creates or replaces a session entry using the specified session_id
DELETE /v2/{project_id}/sessions/{sessions_id} Deletes the specified session information
PATCH /v2/{project_id}/sessions/{sessions_id} Updates part of the session document
POST /v2/{project_id}/sessions/{sessions_id}/action requests actions (e.g. start/end) upon a specific session
PUT /v2/{project_id}/sessions/{sessions_id}/jobs/{job_id} adds the job to the session
DELETE /v2/{project_id}/sessions/{sessions_id}/jobs/{job_id} adds the job to the session