diff --git a/docs/api/examples/delete_projectuuid.txt b/docs/api/examples/delete_projectuuid.txt new file mode 100644 index 00000000..68989437 --- /dev/null +++ b/docs/api/examples/delete_projectuuid.txt @@ -0,0 +1,13 @@ +curl -i -X DELETE 'http://localhost:8000/project/{uuid}' + +DELETE /project/{uuid} HTTP/1.1 + + + +HTTP/1.1 204 +CONNECTION: close +CONTENT-LENGTH: 0 +DATE: Thu, 08 Jan 2015 16:09:15 GMT +SERVER: Python/3.4 aiohttp/0.13.1 +X-ROUTE: /project/{uuid} + diff --git a/docs/api/examples/get_vpcsuuid.txt b/docs/api/examples/get_vpcsuuid.txt index 23e0c6af..a414aadd 100644 --- a/docs/api/examples/get_vpcsuuid.txt +++ b/docs/api/examples/get_vpcsuuid.txt @@ -18,5 +18,5 @@ X-ROUTE: /vpcs/{uuid} "project_uuid": "a1e920ca-338a-4e9f-b363-aa607b09dd80", "script_file": null, "startup_script": null, - "uuid": "925c4d08-58a5-4078-9e77-a6875e0c28dc" + "uuid": "fbbcc900-7fd1-4fcc-bc70-5f7eee8397b9" } diff --git a/docs/api/examples/post_project.txt b/docs/api/examples/post_project.txt index 68d9d07c..4f40b3a4 100644 --- a/docs/api/examples/post_project.txt +++ b/docs/api/examples/post_project.txt @@ -9,7 +9,7 @@ POST /project HTTP/1.1 HTTP/1.1 200 CONNECTION: close -CONTENT-LENGTH: 78 +CONTENT-LENGTH: 102 CONTENT-TYPE: application/json DATE: Thu, 08 Jan 2015 16:09:15 GMT SERVER: Python/3.4 aiohttp/0.13.1 @@ -17,5 +17,6 @@ X-ROUTE: /project { "location": "/tmp", + "temporary": false, "uuid": "00010203-0405-0607-0809-0a0b0c0d0e0f" } diff --git a/docs/api/examples/post_projectuuidclose.txt b/docs/api/examples/post_projectuuidclose.txt new file mode 100644 index 00000000..d038c178 --- /dev/null +++ b/docs/api/examples/post_projectuuidclose.txt @@ -0,0 +1,13 @@ +curl -i -X POST 'http://localhost:8000/project/{uuid}/close' -d '{}' + +POST /project/{uuid}/close HTTP/1.1 +{} + + +HTTP/1.1 204 +CONNECTION: close +CONTENT-LENGTH: 0 +DATE: Thu, 08 Jan 2015 16:09:15 GMT +SERVER: Python/3.4 aiohttp/0.13.1 +X-ROUTE: /project/{uuid}/close + diff --git a/docs/api/examples/post_projectuuidcommit.txt b/docs/api/examples/post_projectuuidcommit.txt new file mode 100644 index 00000000..b5d0c2d9 --- /dev/null +++ b/docs/api/examples/post_projectuuidcommit.txt @@ -0,0 +1,13 @@ +curl -i -X POST 'http://localhost:8000/project/{uuid}/commit' -d '{}' + +POST /project/{uuid}/commit HTTP/1.1 +{} + + +HTTP/1.1 204 +CONNECTION: close +CONTENT-LENGTH: 0 +DATE: Thu, 08 Jan 2015 16:09:15 GMT +SERVER: Python/3.4 aiohttp/0.13.1 +X-ROUTE: /project/{uuid}/commit + diff --git a/docs/api/examples/post_virtualbox.txt b/docs/api/examples/post_virtualbox.txt index fdb19bc6..53195c53 100644 --- a/docs/api/examples/post_virtualbox.txt +++ b/docs/api/examples/post_virtualbox.txt @@ -11,14 +11,21 @@ POST /virtualbox HTTP/1.1 HTTP/1.1 201 CONNECTION: close -CONTENT-LENGTH: 133 +CONTENT-LENGTH: 348 CONTENT-TYPE: application/json DATE: Thu, 08 Jan 2015 16:09:15 GMT SERVER: Python/3.4 aiohttp/0.13.1 X-ROUTE: /virtualbox { + "adapter_start_index": 0, + "adapter_type": "Intel PRO/1000 MT Desktop (82540EM)", + "adapters": 0, + "enable_remote_console": false, + "headless": false, + "linked_clone": false, "name": "VM1", "project_uuid": "a1e920ca-338a-4e9f-b363-aa607b09dd80", - "uuid": "c220788f-ee1e-491c-b318-6542d2f130bf" + "uuid": "2908d568-4a42-49e1-9628-d914f2fd545d", + "vmname": "VM1" } diff --git a/docs/api/examples/post_vpcs.txt b/docs/api/examples/post_vpcs.txt index b66cac02..186c71ea 100644 --- a/docs/api/examples/post_vpcs.txt +++ b/docs/api/examples/post_vpcs.txt @@ -21,5 +21,5 @@ X-ROUTE: /vpcs "project_uuid": "a1e920ca-338a-4e9f-b363-aa607b09dd80", "script_file": null, "startup_script": null, - "uuid": "4d670947-44a8-4156-8626-adce3faa5ae6" + "uuid": "5a2735f9-c38a-459c-8b7d-70ec56b62a7f" } diff --git a/docs/api/project.rst b/docs/api/project.rst index 22b8dcfb..15a2aa08 100644 --- a/docs/api/project.rst +++ b/docs/api/project.rst @@ -18,6 +18,7 @@ Input +
Name Mandatory Type Description
location string Base directory where the project should be created on remote server
temporary boolean If project is a temporary project
uuid string Project UUID
@@ -27,8 +28,9 @@ Output - - + + +
Name Mandatory Type Description
location string Base directory where the project should be created on remote server
uuid string Project UUID
location ✔ string Base directory where the project should be created on remote server
temporary ✔ boolean If project is a temporary project
uuid ✔ string Project UUID
Sample session diff --git a/docs/api/projectuuid.rst b/docs/api/projectuuid.rst new file mode 100644 index 00000000..68680d7d --- /dev/null +++ b/docs/api/projectuuid.rst @@ -0,0 +1,83 @@ +/project/{uuid} +--------------------------------------------- + +.. contents:: + +GET /project/**{uuid}** +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +Get project informations + +Parameters +********** +- **uuid**: Project instance UUID + +Response status codes +********************** +- **200**: OK +- **404**: Project instance doesn't exist + +Output +******* +.. raw:: html + + + + + + +
Name Mandatory Type Description
location ✔ string Base directory where the project should be created on remote server
temporary ✔ boolean If project is a temporary project
uuid ✔ string Project UUID
+ + +PUT /project/**{uuid}** +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +Update a project + +Parameters +********** +- **uuid**: Project instance UUID + +Response status codes +********************** +- **200**: Project updated +- **404**: Project instance doesn't exist + +Input +******* +.. raw:: html + + + + +
Name Mandatory Type Description
temporary boolean If project is a temporary project
+ +Output +******* +.. raw:: html + + + + + + +
Name Mandatory Type Description
location ✔ string Base directory where the project should be created on remote server
temporary ✔ boolean If project is a temporary project
uuid ✔ string Project UUID
+ + +DELETE /project/**{uuid}** +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +Delete a project from disk + +Parameters +********** +- **uuid**: Project instance UUID + +Response status codes +********************** +- **404**: Project instance doesn't exist +- **204**: Changes write on disk + +Sample session +*************** + + +.. literalinclude:: examples/delete_projectuuid.txt + diff --git a/docs/api/projectuuidclose.rst b/docs/api/projectuuidclose.rst new file mode 100644 index 00000000..dffca28c --- /dev/null +++ b/docs/api/projectuuidclose.rst @@ -0,0 +1,24 @@ +/project/{uuid}/close +--------------------------------------------- + +.. contents:: + +POST /project/**{uuid}**/close +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +Close project + +Parameters +********** +- **uuid**: Project instance UUID + +Response status codes +********************** +- **404**: Project instance doesn't exist +- **204**: Project closed + +Sample session +*************** + + +.. literalinclude:: examples/post_projectuuidclose.txt + diff --git a/docs/api/projectuuidcommit.rst b/docs/api/projectuuidcommit.rst new file mode 100644 index 00000000..6bbd35f1 --- /dev/null +++ b/docs/api/projectuuidcommit.rst @@ -0,0 +1,24 @@ +/project/{uuid}/commit +--------------------------------------------- + +.. contents:: + +POST /project/**{uuid}**/commit +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +Write changes on disk + +Parameters +********** +- **uuid**: Project instance UUID + +Response status codes +********************** +- **404**: Project instance doesn't exist +- **204**: Changes write on disk + +Sample session +*************** + + +.. literalinclude:: examples/post_projectuuidcommit.txt + diff --git a/docs/api/virtualbox.rst b/docs/api/virtualbox.rst index 3f96363c..b880491b 100644 --- a/docs/api/virtualbox.rst +++ b/docs/api/virtualbox.rst @@ -33,10 +33,17 @@ Output + + + + + + +
Name Mandatory Type Description
adapter_start_index integer adapter index from which to start using adapters
adapter_type string VirtualBox adapter type
adapters integer number of adapters
console integer console TCP port
enable_remote_console boolean enable the remote console
headless boolean headless mode
linked_clone boolean either the VM is a linked clone or not
name ✔ string VirtualBox VM instance name
project_uuid ✔ string Project UUID
uuid ✔ string VirtualBox VM instance UUID
vmname string VirtualBox VM name (in VirtualBox itself)
Sample session diff --git a/docs/api/virtualboxuuidreload.rst b/docs/api/virtualboxuuidreload.rst new file mode 100644 index 00000000..49fc6fab --- /dev/null +++ b/docs/api/virtualboxuuidreload.rst @@ -0,0 +1,19 @@ +/virtualbox/{uuid}/reload +--------------------------------------------- + +.. contents:: + +POST /virtualbox/**{uuid}**/reload +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +Reload a VirtualBox VM instance + +Parameters +********** +- **uuid**: VirtualBox VM instance UUID + +Response status codes +********************** +- **400**: Invalid VirtualBox VM instance UUID +- **404**: VirtualBox VM instance doesn't exist +- **204**: VirtualBox VM instance reloaded + diff --git a/docs/api/vpcsuuid.rst b/docs/api/vpcsuuid.rst index 43bca0e5..664df1bf 100644 --- a/docs/api/vpcsuuid.rst +++ b/docs/api/vpcsuuid.rst @@ -27,10 +27,15 @@ PUT /vpcs/**{uuid}** ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ Update a VPCS instance +Parameters +********** +- **uuid**: VPCS instance UUID + Response status codes ********************** - **200**: VPCS instance updated - **409**: Conflict +- **404**: VPCS instance doesn't exist Input ******* @@ -58,3 +63,17 @@ Output uuid ✔ string VPCS device UUID + +DELETE /vpcs/**{uuid}** +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +Delete a VPCS instance + +Parameters +********** +- **uuid**: VPCS instance UUID + +Response status codes +********************** +- **404**: VPCS instance doesn't exist +- **204**: VPCS instance deleted + diff --git a/docs/api/vpcsuuidreload.rst b/docs/api/vpcsuuidreload.rst index 263afc08..728a34cf 100644 --- a/docs/api/vpcsuuidreload.rst +++ b/docs/api/vpcsuuidreload.rst @@ -13,6 +13,7 @@ Parameters Response status codes ********************** +- **400**: Invalid VPCS instance UUID - **404**: VPCS instance doesn't exist - **204**: VPCS reloaded