Fix doc generation

docs/api/examples/delete_projectsprojectid.txt

@@ -0,0 +1,13 @@
+curl -i -X DELETE 'http://localhost:8000/projects/{project_id}'
+
+DELETE /projects/{project_id} HTTP/1.1
+
+
+
+HTTP/1.1 204
+CONNECTION: keep-alive
+CONTENT-LENGTH: 0
+DATE: Thu, 08 Jan 2015 16:09:15 GMT
+SERVER: Python/3.4 GNS3/1.3.dev1
+X-ROUTE: /v1/projects/{project_id}
+

docs/api/examples/delete_projectsprojectidiouvmsvmid.txt

@@ -0,0 +1,13 @@
+curl -i -X DELETE 'http://localhost:8000/projects/{project_id}/iou/vms/{vm_id}'
+
+DELETE /projects/{project_id}/iou/vms/{vm_id} HTTP/1.1
+
+
+
+HTTP/1.1 204
+CONNECTION: keep-alive
+CONTENT-LENGTH: 0
+DATE: Thu, 08 Jan 2015 16:09:15 GMT
+SERVER: Python/3.4 GNS3/1.3.dev1
+X-ROUTE: /v1/projects/{project_id}/iou/vms/{vm_id}
+

docs/api/examples/delete_projectsprojectidiouvmsvmidadaptersadapternumberdportsportnumberdnio.txt

@@ -0,0 +1,13 @@
+curl -i -X DELETE 'http://localhost:8000/projects/{project_id}/iou/vms/{vm_id}/adapters/{adapter_number:\d+}/ports/{port_number:\d+}/nio'
+
+DELETE /projects/{project_id}/iou/vms/{vm_id}/adapters/{adapter_number:\d+}/ports/{port_number:\d+}/nio HTTP/1.1
+
+
+
+HTTP/1.1 204
+CONNECTION: keep-alive
+CONTENT-LENGTH: 0
+DATE: Thu, 08 Jan 2015 16:09:15 GMT
+SERVER: Python/3.4 GNS3/1.3.dev1
+X-ROUTE: /v1/projects/{project_id}/iou/vms/{vm_id}/adapters/{adapter_number:\d+}/ports/{port_number:\d+}/nio
+

docs/api/examples/delete_projectsprojectidqemuvmsvmid.txt

@@ -0,0 +1,13 @@
+curl -i -X DELETE 'http://localhost:8000/projects/{project_id}/qemu/vms/{vm_id}'
+
+DELETE /projects/{project_id}/qemu/vms/{vm_id} HTTP/1.1
+
+
+
+HTTP/1.1 204
+CONNECTION: keep-alive
+CONTENT-LENGTH: 0
+DATE: Thu, 08 Jan 2015 16:09:15 GMT
+SERVER: Python/3.4 GNS3/1.3.dev1
+X-ROUTE: /v1/projects/{project_id}/qemu/vms/{vm_id}
+

docs/api/examples/delete_projectsprojectidqemuvmsvmidadaptersadapternumberdportsportnumberdnio.txt

@@ -0,0 +1,13 @@
+curl -i -X DELETE 'http://localhost:8000/projects/{project_id}/qemu/vms/{vm_id}/adapters/{adapter_number:\d+}/ports/{port_number:\d+}/nio'
+
+DELETE /projects/{project_id}/qemu/vms/{vm_id}/adapters/{adapter_number:\d+}/ports/{port_number:\d+}/nio HTTP/1.1
+
+
+
+HTTP/1.1 204
+CONNECTION: keep-alive
+CONTENT-LENGTH: 0
+DATE: Thu, 08 Jan 2015 16:09:15 GMT
+SERVER: Python/3.4 GNS3/1.3.dev1
+X-ROUTE: /v1/projects/{project_id}/qemu/vms/{vm_id}/adapters/{adapter_number:\d+}/ports/{port_number:\d+}/nio
+

docs/api/examples/delete_projectsprojectidvirtualboxvmsvmidadaptersadapternumberdportsportnumberdnio.txt

@@ -0,0 +1,13 @@
+curl -i -X DELETE 'http://localhost:8000/projects/{project_id}/virtualbox/vms/{vm_id}/adapters/{adapter_number:\d+}/ports/{port_number:\d+}/nio'
+
+DELETE /projects/{project_id}/virtualbox/vms/{vm_id}/adapters/{adapter_number:\d+}/ports/{port_number:\d+}/nio HTTP/1.1
+
+
+
+HTTP/1.1 204
+CONNECTION: keep-alive
+CONTENT-LENGTH: 0
+DATE: Thu, 08 Jan 2015 16:09:15 GMT
+SERVER: Python/3.4 GNS3/1.3.dev1
+X-ROUTE: /v1/projects/{project_id}/virtualbox/vms/{vm_id}/adapters/{adapter_number:\d+}/ports/{port_number:\d+}/nio
+

docs/api/examples/delete_projectsprojectidvpcsvmsvmid.txt

@@ -0,0 +1,13 @@
+curl -i -X DELETE 'http://localhost:8000/projects/{project_id}/vpcs/vms/{vm_id}'
+
+DELETE /projects/{project_id}/vpcs/vms/{vm_id} HTTP/1.1
+
+
+
+HTTP/1.1 204
+CONNECTION: keep-alive
+CONTENT-LENGTH: 0
+DATE: Thu, 08 Jan 2015 16:09:15 GMT
+SERVER: Python/3.4 GNS3/1.3.dev1
+X-ROUTE: /v1/projects/{project_id}/vpcs/vms/{vm_id}
+

docs/api/examples/delete_projectsprojectidvpcsvmsvmidadaptersadapternumberdportsportnumberdnio.txt

@@ -0,0 +1,13 @@
+curl -i -X DELETE 'http://localhost:8000/projects/{project_id}/vpcs/vms/{vm_id}/adapters/{adapter_number:\d+}/ports/{port_number:\d+}/nio'
+
+DELETE /projects/{project_id}/vpcs/vms/{vm_id}/adapters/{adapter_number:\d+}/ports/{port_number:\d+}/nio HTTP/1.1
+
+
+
+HTTP/1.1 204
+CONNECTION: keep-alive
+CONTENT-LENGTH: 0
+DATE: Thu, 08 Jan 2015 16:09:15 GMT
+SERVER: Python/3.4 GNS3/1.3.dev1
+X-ROUTE: /v1/projects/{project_id}/vpcs/vms/{vm_id}/adapters/{adapter_number:\d+}/ports/{port_number:\d+}/nio
+

docs/api/examples/get_interfaces.txt

@@ -0,0 +1,52 @@
+curl -i -X GET 'http://localhost:8000/interfaces'
+
+GET /interfaces HTTP/1.1
+
+
+
+HTTP/1.1 200
+CONNECTION: keep-alive
+CONTENT-LENGTH: 520
+CONTENT-TYPE: application/json
+DATE: Thu, 08 Jan 2015 16:09:15 GMT
+SERVER: Python/3.4 GNS3/1.3.dev1
+X-ROUTE: /v1/interfaces
+
+[
+    {
+        "id": "lo0",
+        "name": "lo0"
+    },
+    {
+        "id": "gif0",
+        "name": "gif0"
+    },
+    {
+        "id": "stf0",
+        "name": "stf0"
+    },
+    {
+        "id": "en0",
+        "name": "en0"
+    },
+    {
+        "id": "en1",
+        "name": "en1"
+    },
+    {
+        "id": "fw0",
+        "name": "fw0"
+    },
+    {
+        "id": "en2",
+        "name": "en2"
+    },
+    {
+        "id": "p2p0",
+        "name": "p2p0"
+    },
+    {
+        "id": "bridge0",
+        "name": "bridge0"
+    }
+]

docs/api/examples/get_projectsprojectid.txt

@@ -0,0 +1,20 @@
+curl -i -X GET 'http://localhost:8000/projects/{project_id}'
+
+GET /projects/{project_id} HTTP/1.1
+
+
+
+HTTP/1.1 200
+CONNECTION: keep-alive
+CONTENT-LENGTH: 277
+CONTENT-TYPE: application/json
+DATE: Thu, 08 Jan 2015 16:09:15 GMT
+SERVER: Python/3.4 GNS3/1.3.dev1
+X-ROUTE: /v1/projects/{project_id}
+
+{
+    "location": "/var/folders/3s/r2wbv07n7wg4vrsn874lmxxh0000gn/T/tmpjlh4s0j0",
+    "path": "/var/folders/3s/r2wbv07n7wg4vrsn874lmxxh0000gn/T/tmpjlh4s0j0/00010203-0405-0607-0809-0a0b0c0d0e0f",
+    "project_id": "00010203-0405-0607-0809-0a0b0c0d0e0f",
+    "temporary": false
+}

docs/api/examples/get_projectsprojectidiouvmsvmid.txt

@@ -0,0 +1,27 @@
+curl -i -X GET 'http://localhost:8000/projects/{project_id}/iou/vms/{vm_id}'
+
+GET /projects/{project_id}/iou/vms/{vm_id} HTTP/1.1
+
+
+
+HTTP/1.1 200
+CONNECTION: keep-alive
+CONTENT-LENGTH: 409
+CONTENT-TYPE: application/json
+DATE: Thu, 08 Jan 2015 16:09:15 GMT
+SERVER: Python/3.4 GNS3/1.3.dev1
+X-ROUTE: /v1/projects/{project_id}/iou/vms/{vm_id}
+
+{
+    "console": 2000,
+    "ethernet_adapters": 2,
+    "initial_config": null,
+    "l1_keepalives": false,
+    "name": "PC TEST 1",
+    "nvram": 128,
+    "path": "/private/var/folders/3s/r2wbv07n7wg4vrsn874lmxxh0000gn/T/pytest-3621/test_iou_get0/iou.bin",
+    "project_id": "a1e920ca-338a-4e9f-b363-aa607b09dd80",
+    "ram": 256,
+    "serial_adapters": 2,
+    "vm_id": "f75ff9e7-e658-45f7-9021-1651cfed1194"
+}

docs/api/examples/get_projectsprojectidiouvmsvmidinitialconfig.txt

@@ -0,0 +1,17 @@
+curl -i -X GET 'http://localhost:8000/projects/{project_id}/iou/vms/{vm_id}/initial_config'
+
+GET /projects/{project_id}/iou/vms/{vm_id}/initial_config HTTP/1.1
+
+
+
+HTTP/1.1 200
+CONNECTION: keep-alive
+CONTENT-LENGTH: 25
+CONTENT-TYPE: application/json
+DATE: Thu, 08 Jan 2015 16:09:15 GMT
+SERVER: Python/3.4 GNS3/1.3.dev1
+X-ROUTE: /v1/projects/{project_id}/iou/vms/{vm_id}/initial_config
+
+{
+    "content": "TEST"
+}

docs/api/examples/get_projectsprojectidqemuvmsvmid.txt

@@ -0,0 +1,34 @@
+curl -i -X GET 'http://localhost:8000/projects/{project_id}/qemu/vms/{vm_id}'
+
+GET /projects/{project_id}/qemu/vms/{vm_id} HTTP/1.1
+
+
+
+HTTP/1.1 200
+CONNECTION: keep-alive
+CONTENT-LENGTH: 566
+CONTENT-TYPE: application/json
+DATE: Thu, 08 Jan 2015 16:09:15 GMT
+SERVER: Python/3.4 GNS3/1.3.dev1
+X-ROUTE: /v1/projects/{project_id}/qemu/vms/{vm_id}
+
+{
+    "adapter_type": "e1000",
+    "adapters": 1,
+    "console": 2000,
+    "cpu_throttling": 0,
+    "hda_disk_image": "",
+    "hdb_disk_image": "",
+    "initrd": "",
+    "kernel_command_line": "",
+    "kernel_image": "",
+    "legacy_networking": false,
+    "monitor": 2001,
+    "name": "PC TEST 1",
+    "options": "",
+    "process_priority": "low",
+    "project_id": "a1e920ca-338a-4e9f-b363-aa607b09dd80",
+    "qemu_path": "/var/folders/3s/r2wbv07n7wg4vrsn874lmxxh0000gn/T/tmpu7smjb0q/qemu_x42",
+    "ram": 256,
+    "vm_id": "b41caecc-86fc-4986-a0b2-36892ac8baba"
+}

docs/api/examples/get_projectsprojectidvirtualboxvmsvmid.txt

@@ -0,0 +1,26 @@
+curl -i -X GET 'http://localhost:8000/projects/{project_id}/virtualbox/vms/{vm_id}'
+
+GET /projects/{project_id}/virtualbox/vms/{vm_id} HTTP/1.1
+
+
+
+HTTP/1.1 200
+CONNECTION: keep-alive
+CONTENT-LENGTH: 347
+CONTENT-TYPE: application/json
+DATE: Thu, 08 Jan 2015 16:09:15 GMT
+SERVER: Python/3.4 GNS3/1.3.dev1
+X-ROUTE: /v1/projects/{project_id}/virtualbox/vms/{vm_id}
+
+{
+    "adapter_type": "Intel PRO/1000 MT Desktop (82540EM)",
+    "adapters": 0,
+    "console": 2001,
+    "enable_remote_console": false,
+    "headless": false,
+    "name": "VMTEST",
+    "project_id": "a1e920ca-338a-4e9f-b363-aa607b09dd80",
+    "use_any_adapter": false,
+    "vm_id": "bb20d4fa-f233-400d-af07-2fbdcb337022",
+    "vmname": "VMTEST"
+}

docs/api/examples/get_projectsprojectidvpcsvmsvmid.txt

@@ -0,0 +1,21 @@
+curl -i -X GET 'http://localhost:8000/projects/{project_id}/vpcs/vms/{vm_id}'
+
+GET /projects/{project_id}/vpcs/vms/{vm_id} HTTP/1.1
+
+
+
+HTTP/1.1 200
+CONNECTION: keep-alive
+CONTENT-LENGTH: 187
+CONTENT-TYPE: application/json
+DATE: Thu, 08 Jan 2015 16:09:15 GMT
+SERVER: Python/3.4 GNS3/1.3.dev1
+X-ROUTE: /v1/projects/{project_id}/vpcs/vms/{vm_id}
+
+{
+    "console": 2009,
+    "name": "PC TEST 1",
+    "project_id": "a1e920ca-338a-4e9f-b363-aa607b09dd80",
+    "startup_script": null,
+    "vm_id": "1b0843ea-4fcf-4d2a-94e8-bc3b7a92be88"
+}

docs/api/examples/get_qemubinaries.txt

@@ -0,0 +1,24 @@
+curl -i -X GET 'http://localhost:8000/qemu/binaries'
+
+GET /qemu/binaries HTTP/1.1
+
+
+
+HTTP/1.1 200
+CONNECTION: keep-alive
+CONTENT-LENGTH: 134
+CONTENT-TYPE: application/json
+DATE: Thu, 08 Jan 2015 16:09:15 GMT
+SERVER: Python/3.4 GNS3/1.3.dev1
+X-ROUTE: /v1/qemu/binaries
+
+[
+    {
+        "path": "/tmp/1",
+        "version": "2.2.0"
+    },
+    {
+        "path": "/tmp/2",
+        "version": "2.1.0"
+    }
+]

docs/api/examples/get_version.txt

@@ -0,0 +1,17 @@
+curl -i -X GET 'http://localhost:8000/version'
+
+GET /version HTTP/1.1
+
+
+
+HTTP/1.1 200
+CONNECTION: keep-alive
+CONTENT-LENGTH: 29
+CONTENT-TYPE: application/json
+DATE: Thu, 08 Jan 2015 16:09:15 GMT
+SERVER: Python/3.4 GNS3/1.3.dev1
+X-ROUTE: /v1/version
+
+{
+    "version": "1.3.dev1"
+}

docs/api/examples/post_portsudp.txt

@@ -0,0 +1,17 @@
+curl -i -X POST 'http://localhost:8000/ports/udp' -d '{}'
+
+POST /ports/udp HTTP/1.1
+{}
+
+
+HTTP/1.1 201
+CONNECTION: keep-alive
+CONTENT-LENGTH: 25
+CONTENT-TYPE: application/json
+DATE: Thu, 08 Jan 2015 16:09:15 GMT
+SERVER: Python/3.4 GNS3/1.3.dev1
+X-ROUTE: /v1/ports/udp
+
+{
+    "udp_port": 10000
+}

docs/api/examples/post_projects.txt

@@ -0,0 +1,20 @@
+curl -i -X POST 'http://localhost:8000/projects' -d '{}'
+
+POST /projects HTTP/1.1
+{}
+
+
+HTTP/1.1 200
+CONNECTION: keep-alive
+CONTENT-LENGTH: 277
+CONTENT-TYPE: application/json
+DATE: Thu, 08 Jan 2015 16:09:15 GMT
+SERVER: Python/3.4 GNS3/1.3.dev1
+X-ROUTE: /v1/projects
+
+{
+    "location": "/var/folders/3s/r2wbv07n7wg4vrsn874lmxxh0000gn/T/tmpanmwxfqf",
+    "path": "/var/folders/3s/r2wbv07n7wg4vrsn874lmxxh0000gn/T/tmpanmwxfqf/f0f4987c-b1d3-432f-a354-1179d1c727f9",
+    "project_id": "f0f4987c-b1d3-432f-a354-1179d1c727f9",
+    "temporary": false
+}

docs/api/examples/post_projectsprojectidclose.txt

@@ -0,0 +1,13 @@
+curl -i -X POST 'http://localhost:8000/projects/{project_id}/close' -d '{}'
+
+POST /projects/{project_id}/close HTTP/1.1
+{}
+
+
+HTTP/1.1 204
+CONNECTION: keep-alive
+CONTENT-LENGTH: 0
+DATE: Thu, 08 Jan 2015 16:09:15 GMT
+SERVER: Python/3.4 GNS3/1.3.dev1
+X-ROUTE: /v1/projects/{project_id}/close
+

docs/api/examples/post_projectsprojectidcommit.txt

@@ -0,0 +1,13 @@
+curl -i -X POST 'http://localhost:8000/projects/{project_id}/commit' -d '{}'
+
+POST /projects/{project_id}/commit HTTP/1.1
+{}
+
+
+HTTP/1.1 204
+CONNECTION: keep-alive
+CONTENT-LENGTH: 0
+DATE: Thu, 08 Jan 2015 16:09:15 GMT
+SERVER: Python/3.4 GNS3/1.3.dev1
+X-ROUTE: /v1/projects/{project_id}/commit
+

docs/api/examples/post_projectsprojectidiouvms.txt

@@ -0,0 +1,36 @@
+curl -i -X POST 'http://localhost:8000/projects/{project_id}/iou/vms' -d '{"ethernet_adapters": 0, "initial_config_content": "hostname test", "l1_keepalives": true, "name": "PC TEST 1", "nvram": 512, "path": "/private/var/folders/3s/r2wbv07n7wg4vrsn874lmxxh0000gn/T/pytest-3621/test_iou_create_with_params0/iou.bin", "ram": 1024, "serial_adapters": 4}'
+
+POST /projects/{project_id}/iou/vms HTTP/1.1
+{
+    "ethernet_adapters": 0,
+    "initial_config_content": "hostname test",
+    "l1_keepalives": true,
+    "name": "PC TEST 1",
+    "nvram": 512,
+    "path": "/private/var/folders/3s/r2wbv07n7wg4vrsn874lmxxh0000gn/T/pytest-3621/test_iou_create_with_params0/iou.bin",
+    "ram": 1024,
+    "serial_adapters": 4
+}
+
+
+HTTP/1.1 201
+CONNECTION: keep-alive
+CONTENT-LENGTH: 440
+CONTENT-TYPE: application/json
+DATE: Thu, 08 Jan 2015 16:09:15 GMT
+SERVER: Python/3.4 GNS3/1.3.dev1
+X-ROUTE: /v1/projects/{project_id}/iou/vms
+
+{
+    "console": 2000,
+    "ethernet_adapters": 0,
+    "initial_config": "initial-config.cfg",
+    "l1_keepalives": true,
+    "name": "PC TEST 1",
+    "nvram": 512,
+    "path": "/private/var/folders/3s/r2wbv07n7wg4vrsn874lmxxh0000gn/T/pytest-3621/test_iou_create_with_params0/iou.bin",
+    "project_id": "a1e920ca-338a-4e9f-b363-aa607b09dd80",
+    "ram": 1024,
+    "serial_adapters": 4,
+    "vm_id": "20e66cd4-52ef-4ad2-a44e-16bce06fd6f2"
+}

docs/api/examples/post_projectsprojectidiouvmsvmidadaptersadapternumberdportsportnumberdnio.txt

@@ -0,0 +1,21 @@
+curl -i -X POST 'http://localhost:8000/projects/{project_id}/iou/vms/{vm_id}/adapters/{adapter_number:\d+}/ports/{port_number:\d+}/nio' -d '{"ethernet_device": "eth0", "type": "nio_generic_ethernet"}'
+
+POST /projects/{project_id}/iou/vms/{vm_id}/adapters/{adapter_number:\d+}/ports/{port_number:\d+}/nio HTTP/1.1
+{
+    "ethernet_device": "eth0",
+    "type": "nio_generic_ethernet"
+}
+
+
+HTTP/1.1 201
+CONNECTION: keep-alive
+CONTENT-LENGTH: 69
+CONTENT-TYPE: application/json
+DATE: Thu, 08 Jan 2015 16:09:15 GMT
+SERVER: Python/3.4 GNS3/1.3.dev1
+X-ROUTE: /v1/projects/{project_id}/iou/vms/{vm_id}/adapters/{adapter_number:\d+}/ports/{port_number:\d+}/nio
+
+{
+    "ethernet_device": "eth0",
+    "type": "nio_generic_ethernet"
+}

docs/api/examples/post_projectsprojectidiouvmsvmidadaptersadapternumberdportsportnumberdstartcapture.txt

@@ -0,0 +1,20 @@
+curl -i -X POST 'http://localhost:8000/projects/{project_id}/iou/vms/{vm_id}/adapters/{adapter_number:\d+}/ports/{port_number:\d+}/start_capture' -d '{"capture_file_name": "test.pcap", "data_link_type": "DLT_EN10MB"}'
+
+POST /projects/{project_id}/iou/vms/{vm_id}/adapters/{adapter_number:\d+}/ports/{port_number:\d+}/start_capture HTTP/1.1
+{
+    "capture_file_name": "test.pcap",
+    "data_link_type": "DLT_EN10MB"
+}
+
+
+HTTP/1.1 200
+CONNECTION: keep-alive
+CONTENT-LENGTH: 158
+CONTENT-TYPE: application/json
+DATE: Thu, 08 Jan 2015 16:09:15 GMT
+SERVER: Python/3.4 GNS3/1.3.dev1
+X-ROUTE: /v1/projects/{project_id}/iou/vms/{vm_id}/adapters/{adapter_number:\d+}/ports/{port_number:\d+}/start_capture
+
+{
+    "pcap_file_path": "/var/folders/3s/r2wbv07n7wg4vrsn874lmxxh0000gn/T/tmpd25gn8du/a1e920ca-338a-4e9f-b363-aa607b09dd80/project-files/captures/test.pcap"
+}

docs/api/examples/post_projectsprojectidiouvmsvmidadaptersadapternumberdportsportnumberdstopcapture.txt

@@ -0,0 +1,13 @@
+curl -i -X POST 'http://localhost:8000/projects/{project_id}/iou/vms/{vm_id}/adapters/{adapter_number:\d+}/ports/{port_number:\d+}/stop_capture' -d '{}'
+
+POST /projects/{project_id}/iou/vms/{vm_id}/adapters/{adapter_number:\d+}/ports/{port_number:\d+}/stop_capture HTTP/1.1
+{}
+
+
+HTTP/1.1 204
+CONNECTION: keep-alive
+CONTENT-LENGTH: 0
+DATE: Thu, 08 Jan 2015 16:09:15 GMT
+SERVER: Python/3.4 GNS3/1.3.dev1
+X-ROUTE: /v1/projects/{project_id}/iou/vms/{vm_id}/adapters/{adapter_number:\d+}/ports/{port_number:\d+}/stop_capture
+

docs/api/examples/post_projectsprojectidiouvmsvmidreload.txt

@@ -0,0 +1,13 @@
+curl -i -X POST 'http://localhost:8000/projects/{project_id}/iou/vms/{vm_id}/reload' -d '{}'
+
+POST /projects/{project_id}/iou/vms/{vm_id}/reload HTTP/1.1
+{}
+
+
+HTTP/1.1 204
+CONNECTION: keep-alive
+CONTENT-LENGTH: 0
+DATE: Thu, 08 Jan 2015 16:09:15 GMT
+SERVER: Python/3.4 GNS3/1.3.dev1
+X-ROUTE: /v1/projects/{project_id}/iou/vms/{vm_id}/reload
+

docs/api/examples/post_projectsprojectidiouvmsvmidstart.txt

@@ -0,0 +1,13 @@
+curl -i -X POST 'http://localhost:8000/projects/{project_id}/iou/vms/{vm_id}/start' -d '{}'
+
+POST /projects/{project_id}/iou/vms/{vm_id}/start HTTP/1.1
+{}
+
+
+HTTP/1.1 204
+CONNECTION: keep-alive
+CONTENT-LENGTH: 0
+DATE: Thu, 08 Jan 2015 16:09:15 GMT
+SERVER: Python/3.4 GNS3/1.3.dev1
+X-ROUTE: /v1/projects/{project_id}/iou/vms/{vm_id}/start
+

docs/api/examples/post_projectsprojectidiouvmsvmidstop.txt

@@ -0,0 +1,13 @@
+curl -i -X POST 'http://localhost:8000/projects/{project_id}/iou/vms/{vm_id}/stop' -d '{}'
+
+POST /projects/{project_id}/iou/vms/{vm_id}/stop HTTP/1.1
+{}
+
+
+HTTP/1.1 204
+CONNECTION: keep-alive
+CONTENT-LENGTH: 0
+DATE: Thu, 08 Jan 2015 16:09:15 GMT
+SERVER: Python/3.4 GNS3/1.3.dev1
+X-ROUTE: /v1/projects/{project_id}/iou/vms/{vm_id}/stop
+

docs/api/examples/post_projectsprojectidqemuvms.txt

@@ -0,0 +1,39 @@
+curl -i -X POST 'http://localhost:8000/projects/{project_id}/qemu/vms' -d '{"hda_disk_image": "hda", "name": "PC TEST 1", "qemu_path": "/var/folders/3s/r2wbv07n7wg4vrsn874lmxxh0000gn/T/tmpu7smjb0q/qemu_x42", "ram": 1024}'
+
+POST /projects/{project_id}/qemu/vms HTTP/1.1
+{
+    "hda_disk_image": "hda",
+    "name": "PC TEST 1",
+    "qemu_path": "/var/folders/3s/r2wbv07n7wg4vrsn874lmxxh0000gn/T/tmpu7smjb0q/qemu_x42",
+    "ram": 1024
+}
+
+
+HTTP/1.1 201
+CONNECTION: keep-alive
+CONTENT-LENGTH: 570
+CONTENT-TYPE: application/json
+DATE: Thu, 08 Jan 2015 16:09:15 GMT
+SERVER: Python/3.4 GNS3/1.3.dev1
+X-ROUTE: /v1/projects/{project_id}/qemu/vms
+
+{
+    "adapter_type": "e1000",
+    "adapters": 1,
+    "console": 2000,
+    "cpu_throttling": 0,
+    "hda_disk_image": "hda",
+    "hdb_disk_image": "",
+    "initrd": "",
+    "kernel_command_line": "",
+    "kernel_image": "",
+    "legacy_networking": false,
+    "monitor": 2001,
+    "name": "PC TEST 1",
+    "options": "",
+    "process_priority": "low",
+    "project_id": "a1e920ca-338a-4e9f-b363-aa607b09dd80",
+    "qemu_path": "/var/folders/3s/r2wbv07n7wg4vrsn874lmxxh0000gn/T/tmpu7smjb0q/qemu_x42",
+    "ram": 1024,
+    "vm_id": "3176897a-996a-4020-86b8-3cd7a0031cbc"
+}

docs/api/examples/post_projectsprojectidqemuvmsvmidadaptersadapternumberdportsportnumberdnio.txt

@@ -0,0 +1,21 @@
+curl -i -X POST 'http://localhost:8000/projects/{project_id}/qemu/vms/{vm_id}/adapters/{adapter_number:\d+}/ports/{port_number:\d+}/nio' -d '{"ethernet_device": "eth0", "type": "nio_generic_ethernet"}'
+
+POST /projects/{project_id}/qemu/vms/{vm_id}/adapters/{adapter_number:\d+}/ports/{port_number:\d+}/nio HTTP/1.1
+{
+    "ethernet_device": "eth0",
+    "type": "nio_generic_ethernet"
+}
+
+
+HTTP/1.1 201
+CONNECTION: keep-alive
+CONTENT-LENGTH: 69
+CONTENT-TYPE: application/json
+DATE: Thu, 08 Jan 2015 16:09:15 GMT
+SERVER: Python/3.4 GNS3/1.3.dev1
+X-ROUTE: /v1/projects/{project_id}/qemu/vms/{vm_id}/adapters/{adapter_number:\d+}/ports/{port_number:\d+}/nio
+
+{
+    "ethernet_device": "eth0",
+    "type": "nio_generic_ethernet"
+}

docs/api/examples/post_projectsprojectidqemuvmsvmidreload.txt

@@ -0,0 +1,13 @@
+curl -i -X POST 'http://localhost:8000/projects/{project_id}/qemu/vms/{vm_id}/reload' -d '{}'
+
+POST /projects/{project_id}/qemu/vms/{vm_id}/reload HTTP/1.1
+{}
+
+
+HTTP/1.1 204
+CONNECTION: keep-alive
+CONTENT-LENGTH: 0
+DATE: Thu, 08 Jan 2015 16:09:15 GMT
+SERVER: Python/3.4 GNS3/1.3.dev1
+X-ROUTE: /v1/projects/{project_id}/qemu/vms/{vm_id}/reload
+

docs/api/examples/post_projectsprojectidqemuvmsvmidresume.txt

@@ -0,0 +1,13 @@
+curl -i -X POST 'http://localhost:8000/projects/{project_id}/qemu/vms/{vm_id}/resume' -d '{}'
+
+POST /projects/{project_id}/qemu/vms/{vm_id}/resume HTTP/1.1
+{}
+
+
+HTTP/1.1 204
+CONNECTION: keep-alive
+CONTENT-LENGTH: 0
+DATE: Thu, 08 Jan 2015 16:09:15 GMT
+SERVER: Python/3.4 GNS3/1.3.dev1
+X-ROUTE: /v1/projects/{project_id}/qemu/vms/{vm_id}/resume
+

docs/api/examples/post_projectsprojectidqemuvmsvmidstart.txt

@@ -0,0 +1,13 @@
+curl -i -X POST 'http://localhost:8000/projects/{project_id}/qemu/vms/{vm_id}/start' -d '{}'
+
+POST /projects/{project_id}/qemu/vms/{vm_id}/start HTTP/1.1
+{}
+
+
+HTTP/1.1 204
+CONNECTION: keep-alive
+CONTENT-LENGTH: 0
+DATE: Thu, 08 Jan 2015 16:09:15 GMT
+SERVER: Python/3.4 GNS3/1.3.dev1
+X-ROUTE: /v1/projects/{project_id}/qemu/vms/{vm_id}/start
+

docs/api/examples/post_projectsprojectidqemuvmsvmidstop.txt

@@ -0,0 +1,13 @@
+curl -i -X POST 'http://localhost:8000/projects/{project_id}/qemu/vms/{vm_id}/stop' -d '{}'
+
+POST /projects/{project_id}/qemu/vms/{vm_id}/stop HTTP/1.1
+{}
+
+
+HTTP/1.1 204
+CONNECTION: keep-alive
+CONTENT-LENGTH: 0
+DATE: Thu, 08 Jan 2015 16:09:15 GMT
+SERVER: Python/3.4 GNS3/1.3.dev1
+X-ROUTE: /v1/projects/{project_id}/qemu/vms/{vm_id}/stop
+

docs/api/examples/post_projectsprojectidqemuvmsvmidsuspend.txt

@@ -0,0 +1,13 @@
+curl -i -X POST 'http://localhost:8000/projects/{project_id}/qemu/vms/{vm_id}/suspend' -d '{}'
+
+POST /projects/{project_id}/qemu/vms/{vm_id}/suspend HTTP/1.1
+{}
+
+
+HTTP/1.1 204
+CONNECTION: keep-alive
+CONTENT-LENGTH: 0
+DATE: Thu, 08 Jan 2015 16:09:15 GMT
+SERVER: Python/3.4 GNS3/1.3.dev1
+X-ROUTE: /v1/projects/{project_id}/qemu/vms/{vm_id}/suspend
+

docs/api/examples/post_projectsprojectidvirtualboxvms.txt

@@ -0,0 +1,30 @@
+curl -i -X POST 'http://localhost:8000/projects/{project_id}/virtualbox/vms' -d '{"linked_clone": false, "name": "VM1", "vmname": "VM1"}'
+
+POST /projects/{project_id}/virtualbox/vms HTTP/1.1
+{
+    "linked_clone": false,
+    "name": "VM1",
+    "vmname": "VM1"
+}
+
+
+HTTP/1.1 201
+CONNECTION: keep-alive
+CONTENT-LENGTH: 341
+CONTENT-TYPE: application/json
+DATE: Thu, 08 Jan 2015 16:09:15 GMT
+SERVER: Python/3.4 GNS3/1.3.dev1
+X-ROUTE: /v1/projects/{project_id}/virtualbox/vms
+
+{
+    "adapter_type": "Intel PRO/1000 MT Desktop (82540EM)",
+    "adapters": 0,
+    "console": 2000,
+    "enable_remote_console": false,
+    "headless": false,
+    "name": "VM1",
+    "project_id": "a1e920ca-338a-4e9f-b363-aa607b09dd80",
+    "use_any_adapter": false,
+    "vm_id": "8f384969-8478-4e8a-a6cd-c91376ccc89b",
+    "vmname": "VM1"
+}

docs/api/examples/post_projectsprojectidvirtualboxvmsvmidadaptersadapternumberdportsportnumberdnio.txt

@@ -0,0 +1,25 @@
+curl -i -X POST 'http://localhost:8000/projects/{project_id}/virtualbox/vms/{vm_id}/adapters/{adapter_number:\d+}/ports/{port_number:\d+}/nio' -d '{"lport": 4242, "rhost": "127.0.0.1", "rport": 4343, "type": "nio_udp"}'
+
+POST /projects/{project_id}/virtualbox/vms/{vm_id}/adapters/{adapter_number:\d+}/ports/{port_number:\d+}/nio HTTP/1.1
+{
+    "lport": 4242,
+    "rhost": "127.0.0.1",
+    "rport": 4343,
+    "type": "nio_udp"
+}
+
+
+HTTP/1.1 201
+CONNECTION: keep-alive
+CONTENT-LENGTH: 89
+CONTENT-TYPE: application/json
+DATE: Thu, 08 Jan 2015 16:09:15 GMT
+SERVER: Python/3.4 GNS3/1.3.dev1
+X-ROUTE: /v1/projects/{project_id}/virtualbox/vms/{vm_id}/adapters/{adapter_number:\d+}/ports/{port_number:\d+}/nio
+
+{
+    "lport": 4242,
+    "rhost": "127.0.0.1",
+    "rport": 4343,
+    "type": "nio_udp"
+}

docs/api/examples/post_projectsprojectidvirtualboxvmsvmidreload.txt

@@ -0,0 +1,13 @@
+curl -i -X POST 'http://localhost:8000/projects/{project_id}/virtualbox/vms/{vm_id}/reload' -d '{}'
+
+POST /projects/{project_id}/virtualbox/vms/{vm_id}/reload HTTP/1.1
+{}
+
+
+HTTP/1.1 204
+CONNECTION: keep-alive
+CONTENT-LENGTH: 0
+DATE: Thu, 08 Jan 2015 16:09:15 GMT
+SERVER: Python/3.4 GNS3/1.3.dev1
+X-ROUTE: /v1/projects/{project_id}/virtualbox/vms/{vm_id}/reload
+

docs/api/examples/post_projectsprojectidvirtualboxvmsvmidresume.txt

@@ -0,0 +1,13 @@
+curl -i -X POST 'http://localhost:8000/projects/{project_id}/virtualbox/vms/{vm_id}/resume' -d '{}'
+
+POST /projects/{project_id}/virtualbox/vms/{vm_id}/resume HTTP/1.1
+{}
+
+
+HTTP/1.1 204
+CONNECTION: keep-alive
+CONTENT-LENGTH: 0
+DATE: Thu, 08 Jan 2015 16:09:15 GMT
+SERVER: Python/3.4 GNS3/1.3.dev1
+X-ROUTE: /v1/projects/{project_id}/virtualbox/vms/{vm_id}/resume
+

docs/api/examples/post_projectsprojectidvirtualboxvmsvmidstart.txt

@@ -0,0 +1,13 @@
+curl -i -X POST 'http://localhost:8000/projects/{project_id}/virtualbox/vms/{vm_id}/start' -d '{}'
+
+POST /projects/{project_id}/virtualbox/vms/{vm_id}/start HTTP/1.1
+{}
+
+
+HTTP/1.1 204
+CONNECTION: keep-alive
+CONTENT-LENGTH: 0
+DATE: Thu, 08 Jan 2015 16:09:15 GMT
+SERVER: Python/3.4 GNS3/1.3.dev1
+X-ROUTE: /v1/projects/{project_id}/virtualbox/vms/{vm_id}/start
+

docs/api/examples/post_projectsprojectidvirtualboxvmsvmidstop.txt

@@ -0,0 +1,13 @@
+curl -i -X POST 'http://localhost:8000/projects/{project_id}/virtualbox/vms/{vm_id}/stop' -d '{}'
+
+POST /projects/{project_id}/virtualbox/vms/{vm_id}/stop HTTP/1.1
+{}
+
+
+HTTP/1.1 204
+CONNECTION: keep-alive
+CONTENT-LENGTH: 0
+DATE: Thu, 08 Jan 2015 16:09:15 GMT
+SERVER: Python/3.4 GNS3/1.3.dev1
+X-ROUTE: /v1/projects/{project_id}/virtualbox/vms/{vm_id}/stop
+

docs/api/examples/post_projectsprojectidvirtualboxvmsvmidsuspend.txt

@@ -0,0 +1,13 @@
+curl -i -X POST 'http://localhost:8000/projects/{project_id}/virtualbox/vms/{vm_id}/suspend' -d '{}'
+
+POST /projects/{project_id}/virtualbox/vms/{vm_id}/suspend HTTP/1.1
+{}
+
+
+HTTP/1.1 204
+CONNECTION: keep-alive
+CONTENT-LENGTH: 0
+DATE: Thu, 08 Jan 2015 16:09:15 GMT
+SERVER: Python/3.4 GNS3/1.3.dev1
+X-ROUTE: /v1/projects/{project_id}/virtualbox/vms/{vm_id}/suspend
+

docs/api/examples/post_projectsprojectidvpcsvms.txt

@@ -0,0 +1,23 @@
+curl -i -X POST 'http://localhost:8000/projects/{project_id}/vpcs/vms' -d '{"name": "PC TEST 1"}'
+
+POST /projects/{project_id}/vpcs/vms HTTP/1.1
+{
+    "name": "PC TEST 1"
+}
+
+
+HTTP/1.1 201
+CONNECTION: keep-alive
+CONTENT-LENGTH: 187
+CONTENT-TYPE: application/json
+DATE: Thu, 08 Jan 2015 16:09:15 GMT
+SERVER: Python/3.4 GNS3/1.3.dev1
+X-ROUTE: /v1/projects/{project_id}/vpcs/vms
+
+{
+    "console": 2009,
+    "name": "PC TEST 1",
+    "project_id": "a1e920ca-338a-4e9f-b363-aa607b09dd80",
+    "startup_script": null,
+    "vm_id": "90e4cc09-4013-4e94-97ce-3ca48676de22"
+}

docs/api/examples/post_projectsprojectidvpcsvmsvmidadaptersadapternumberdportsportnumberdnio.txt

@@ -0,0 +1,25 @@
+curl -i -X POST 'http://localhost:8000/projects/{project_id}/vpcs/vms/{vm_id}/adapters/{adapter_number:\d+}/ports/{port_number:\d+}/nio' -d '{"lport": 4242, "rhost": "127.0.0.1", "rport": 4343, "type": "nio_udp"}'
+
+POST /projects/{project_id}/vpcs/vms/{vm_id}/adapters/{adapter_number:\d+}/ports/{port_number:\d+}/nio HTTP/1.1
+{
+    "lport": 4242,
+    "rhost": "127.0.0.1",
+    "rport": 4343,
+    "type": "nio_udp"
+}
+
+
+HTTP/1.1 201
+CONNECTION: keep-alive
+CONTENT-LENGTH: 89
+CONTENT-TYPE: application/json
+DATE: Thu, 08 Jan 2015 16:09:15 GMT
+SERVER: Python/3.4 GNS3/1.3.dev1
+X-ROUTE: /v1/projects/{project_id}/vpcs/vms/{vm_id}/adapters/{adapter_number:\d+}/ports/{port_number:\d+}/nio
+
+{
+    "lport": 4242,
+    "rhost": "127.0.0.1",
+    "rport": 4343,
+    "type": "nio_udp"
+}

docs/api/examples/post_projectsprojectidvpcsvmsvmidreload.txt

@@ -0,0 +1,13 @@
+curl -i -X POST 'http://localhost:8000/projects/{project_id}/vpcs/vms/{vm_id}/reload' -d '{}'
+
+POST /projects/{project_id}/vpcs/vms/{vm_id}/reload HTTP/1.1
+{}
+
+
+HTTP/1.1 204
+CONNECTION: keep-alive
+CONTENT-LENGTH: 0
+DATE: Thu, 08 Jan 2015 16:09:15 GMT
+SERVER: Python/3.4 GNS3/1.3.dev1
+X-ROUTE: /v1/projects/{project_id}/vpcs/vms/{vm_id}/reload
+

docs/api/examples/post_projectsprojectidvpcsvmsvmidstart.txt

@@ -0,0 +1,13 @@
+curl -i -X POST 'http://localhost:8000/projects/{project_id}/vpcs/vms/{vm_id}/start' -d '{}'
+
+POST /projects/{project_id}/vpcs/vms/{vm_id}/start HTTP/1.1
+{}
+
+
+HTTP/1.1 204
+CONNECTION: keep-alive
+CONTENT-LENGTH: 0
+DATE: Thu, 08 Jan 2015 16:09:15 GMT
+SERVER: Python/3.4 GNS3/1.3.dev1
+X-ROUTE: /v1/projects/{project_id}/vpcs/vms/{vm_id}/start
+

docs/api/examples/post_projectsprojectidvpcsvmsvmidstop.txt

@@ -0,0 +1,13 @@
+curl -i -X POST 'http://localhost:8000/projects/{project_id}/vpcs/vms/{vm_id}/stop' -d '{}'
+
+POST /projects/{project_id}/vpcs/vms/{vm_id}/stop HTTP/1.1
+{}
+
+
+HTTP/1.1 204
+CONNECTION: keep-alive
+CONTENT-LENGTH: 0
+DATE: Thu, 08 Jan 2015 16:09:15 GMT
+SERVER: Python/3.4 GNS3/1.3.dev1
+X-ROUTE: /v1/projects/{project_id}/vpcs/vms/{vm_id}/stop
+

docs/api/examples/post_version.txt

@@ -0,0 +1,19 @@
+curl -i -X POST 'http://localhost:8000/version' -d '{"version": "1.3.dev1"}'
+
+POST /version HTTP/1.1
+{
+    "version": "1.3.dev1"
+}
+
+
+HTTP/1.1 200
+CONNECTION: keep-alive
+CONTENT-LENGTH: 29
+CONTENT-TYPE: application/json
+DATE: Thu, 08 Jan 2015 16:09:15 GMT
+SERVER: Python/3.4 GNS3/1.3.dev1
+X-ROUTE: /v1/version
+
+{
+    "version": "1.3.dev1"
+}

docs/api/examples/put_projectsprojectid.txt

@@ -0,0 +1,20 @@
+curl -i -X PUT 'http://localhost:8000/projects/{project_id}' -d '{"path": "/private/var/folders/3s/r2wbv07n7wg4vrsn874lmxxh0000gn/T/pytest-3621/test_update_path_project_non_l0"}'
+
+PUT /projects/{project_id} HTTP/1.1
+{
+    "path": "/private/var/folders/3s/r2wbv07n7wg4vrsn874lmxxh0000gn/T/pytest-3621/test_update_path_project_non_l0"
+}
+
+
+HTTP/1.1 403
+CONNECTION: keep-alive
+CONTENT-LENGTH: 100
+CONTENT-TYPE: application/json
+DATE: Thu, 08 Jan 2015 16:09:15 GMT
+SERVER: Python/3.4 GNS3/1.3.dev1
+X-ROUTE: /v1/projects/{project_id}
+
+{
+    "message": "You are not allowed to modify the project directory location",
+    "status": 403
+}

docs/api/examples/put_projectsprojectidiouvmsvmid.txt

@@ -0,0 +1,36 @@
+curl -i -X PUT 'http://localhost:8000/projects/{project_id}/iou/vms/{vm_id}' -d '{"console": 2001, "ethernet_adapters": 4, "initial_config_content": "hostname test", "l1_keepalives": true, "name": "test", "nvram": 2048, "ram": 512, "serial_adapters": 0}'
+
+PUT /projects/{project_id}/iou/vms/{vm_id} HTTP/1.1
+{
+    "console": 2001,
+    "ethernet_adapters": 4,
+    "initial_config_content": "hostname test",
+    "l1_keepalives": true,
+    "name": "test",
+    "nvram": 2048,
+    "ram": 512,
+    "serial_adapters": 0
+}
+
+
+HTTP/1.1 200
+CONNECTION: keep-alive
+CONTENT-LENGTH: 423
+CONTENT-TYPE: application/json
+DATE: Thu, 08 Jan 2015 16:09:15 GMT
+SERVER: Python/3.4 GNS3/1.3.dev1
+X-ROUTE: /v1/projects/{project_id}/iou/vms/{vm_id}
+
+{
+    "console": 2001,
+    "ethernet_adapters": 4,
+    "initial_config": "initial-config.cfg",
+    "l1_keepalives": true,
+    "name": "test",
+    "nvram": 2048,
+    "path": "/private/var/folders/3s/r2wbv07n7wg4vrsn874lmxxh0000gn/T/pytest-3621/test_iou_update0/iou.bin",
+    "project_id": "a1e920ca-338a-4e9f-b363-aa607b09dd80",
+    "ram": 512,
+    "serial_adapters": 0,
+    "vm_id": "e867af73-aaf1-4770-a935-78a357ea5db3"
+}

docs/api/examples/put_projectsprojectidqemuvmsvmid.txt

@@ -0,0 +1,39 @@
+curl -i -X PUT 'http://localhost:8000/projects/{project_id}/qemu/vms/{vm_id}' -d '{"console": 2002, "hdb_disk_image": "hdb", "name": "test", "ram": 1024}'
+
+PUT /projects/{project_id}/qemu/vms/{vm_id} HTTP/1.1
+{
+    "console": 2002,
+    "hdb_disk_image": "hdb",
+    "name": "test",
+    "ram": 1024
+}
+
+
+HTTP/1.1 200
+CONNECTION: keep-alive
+CONTENT-LENGTH: 565
+CONTENT-TYPE: application/json
+DATE: Thu, 08 Jan 2015 16:09:15 GMT
+SERVER: Python/3.4 GNS3/1.3.dev1
+X-ROUTE: /v1/projects/{project_id}/qemu/vms/{vm_id}
+
+{
+    "adapter_type": "e1000",
+    "adapters": 1,
+    "console": 2002,
+    "cpu_throttling": 0,
+    "hda_disk_image": "",
+    "hdb_disk_image": "hdb",
+    "initrd": "",
+    "kernel_command_line": "",
+    "kernel_image": "",
+    "legacy_networking": false,
+    "monitor": 2001,
+    "name": "test",
+    "options": "",
+    "process_priority": "low",
+    "project_id": "a1e920ca-338a-4e9f-b363-aa607b09dd80",
+    "qemu_path": "/var/folders/3s/r2wbv07n7wg4vrsn874lmxxh0000gn/T/tmpu7smjb0q/qemu_x42",
+    "ram": 1024,
+    "vm_id": "8a0d735b-d485-4a2e-bae1-be54f426fbeb"
+}

docs/api/examples/put_projectsprojectidvirtualboxvmsvmid.txt

@@ -0,0 +1,29 @@
+curl -i -X PUT 'http://localhost:8000/projects/{project_id}/virtualbox/vms/{vm_id}' -d '{"console": 2010, "name": "test"}'
+
+PUT /projects/{project_id}/virtualbox/vms/{vm_id} HTTP/1.1
+{
+    "console": 2010,
+    "name": "test"
+}
+
+
+HTTP/1.1 200
+CONNECTION: keep-alive
+CONTENT-LENGTH: 345
+CONTENT-TYPE: application/json
+DATE: Thu, 08 Jan 2015 16:09:15 GMT
+SERVER: Python/3.4 GNS3/1.3.dev1
+X-ROUTE: /v1/projects/{project_id}/virtualbox/vms/{vm_id}
+
+{
+    "adapter_type": "Intel PRO/1000 MT Desktop (82540EM)",
+    "adapters": 0,
+    "console": 2010,
+    "enable_remote_console": false,
+    "headless": false,
+    "name": "test",
+    "project_id": "a1e920ca-338a-4e9f-b363-aa607b09dd80",
+    "use_any_adapter": false,
+    "vm_id": "dcf2c555-703d-47cb-9dd2-8ee6c11b9f6c",
+    "vmname": "VMTEST"
+}

docs/api/examples/put_projectsprojectidvpcsvmsvmid.txt

@@ -0,0 +1,25 @@
+curl -i -X PUT 'http://localhost:8000/projects/{project_id}/vpcs/vms/{vm_id}' -d '{"console": 2011, "name": "test", "startup_script": "ip 192.168.1.1"}'
+
+PUT /projects/{project_id}/vpcs/vms/{vm_id} HTTP/1.1
+{
+    "console": 2011,
+    "name": "test",
+    "startup_script": "ip 192.168.1.1"
+}
+
+
+HTTP/1.1 200
+CONNECTION: keep-alive
+CONTENT-LENGTH: 194
+CONTENT-TYPE: application/json
+DATE: Thu, 08 Jan 2015 16:09:15 GMT
+SERVER: Python/3.4 GNS3/1.3.dev1
+X-ROUTE: /v1/projects/{project_id}/vpcs/vms/{vm_id}
+
+{
+    "console": 2011,
+    "name": "test",
+    "project_id": "a1e920ca-338a-4e9f-b363-aa607b09dd80",
+    "startup_script": "ip 192.168.1.1",
+    "vm_id": "f27aa7da-e267-483a-adc6-2587e1377e8c"
+}

docs/api/upload.rst

@@ -1,8 +0,0 @@
-Upload
----------------------
-
-.. toctree::
-   :glob:
-   :maxdepth: 2
-
-   upload/*

docs/api/upload/upload.rst

@@ -1,22 +0,0 @@
-/upload
-----------------------------------------------------------------------------------------------------------------------
-
-.. contents::
-
-GET /upload
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-Manage upload of GNS3 images
-
-Response status codes
-**********************
-- **200**: OK
-
-
-POST /upload
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-Manage upload of GNS3 images
-
-Response status codes
-**********************
-- **200**: OK
-

docs/api/v1/dynamips_device.rst

@@ -5,4 +5,4 @@ Dynamips device
    :glob:
    :maxdepth: 2
 
-   api.dynamips_device/*
+   dynamips_device/*

docs/api/v1/dynamips_device/projectsprojectiddynamipsdevicesdeviceidportsportnumberdnio.rst

@@ -10,8 +10,8 @@ Add a NIO to a Dynamips device instance
 Parameters
 **********
 - **project_id**: UUID for the project
-- **device_id**: UUID for the instance
 - **port_number**: Port on the device
+- **device_id**: UUID for the instance
 
 Response status codes
 **********************
@@ -129,8 +129,8 @@ Remove a NIO from a Dynamips device instance
 Parameters
 **********
 - **project_id**: UUID for the project
-- **device_id**: UUID for the instance
 - **port_number**: Port on the device
+- **device_id**: UUID for the instance
 
 Response status codes
 **********************

docs/api/v1/dynamips_device/projectsprojectiddynamipsdevicesdeviceidportsportnumberdstartcapture.rst

@@ -10,8 +10,8 @@ Start a packet capture on a Dynamips device instance
 Parameters
 **********
 - **project_id**: UUID for the project
-- **device_id**: UUID for the instance
 - **port_number**: Port on the device
+- **device_id**: UUID for the instance
 
 Response status codes
 **********************

docs/api/v1/dynamips_device/projectsprojectiddynamipsdevicesdeviceidportsportnumberdstopcapture.rst

@@ -10,8 +10,8 @@ Stop a packet capture on a Dynamips device instance
 Parameters
 **********
 - **project_id**: UUID for the project
-- **device_id**: UUID for the instance
 - **port_number**: Port on the device
+- **device_id**: UUID for the instance
 
 Response status codes
 **********************

docs/api/v1/dynamips_vm.rst

@@ -5,4 +5,4 @@ Dynamips vm
    :glob:
    :maxdepth: 2
 
-   api.dynamips_vm/*
+   dynamips_vm/*

docs/api/v1/dynamips_vm/projectsprojectiddynamipsvmsvmidadaptersadapternumberdportsportnumberdnio.rst

@@ -11,8 +11,8 @@ Parameters
 **********
 - **project_id**: UUID for the project
 - **adapter_number**: Adapter where the nio should be added
-- **port_number**: Port on the adapter
 - **vm_id**: UUID for the instance
+- **port_number**: Port on the adapter
 
 Response status codes
 **********************
@@ -29,8 +29,8 @@ Parameters
 **********
 - **project_id**: UUID for the project
 - **adapter_number**: Adapter from where the nio should be removed
-- **port_number**: Port on the adapter
 - **vm_id**: UUID for the instance
+- **port_number**: Port on the adapter
 
 Response status codes
 **********************

docs/api/v1/dynamips_vm/projectsprojectiddynamipsvmsvmidadaptersadapternumberdportsportnumberdstartcapture.rst

@@ -11,8 +11,8 @@ Parameters
 **********
 - **project_id**: UUID for the project
 - **adapter_number**: Adapter to start a packet capture
-- **port_number**: Port on the adapter
 - **vm_id**: UUID for the instance
+- **port_number**: Port on the adapter
 
 Response status codes
 **********************

docs/api/v1/dynamips_vm/projectsprojectiddynamipsvmsvmidadaptersadapternumberdportsportnumberdstopcapture.rst

@@ -11,8 +11,8 @@ Parameters
 **********
 - **project_id**: UUID for the project
 - **adapter_number**: Adapter to stop a packet capture
-- **port_number**: Port on the adapter (always 0)
 - **vm_id**: UUID for the instance
+- **port_number**: Port on the adapter (always 0)
 
 Response status codes
 **********************

docs/api/v1/iou.rst

@@ -5,4 +5,4 @@ Iou
    :glob:
    :maxdepth: 2
 
-   api.iou/*
+   iou/*

docs/api/v1/iou/projectsprojectidiouvms.rst

@@ -54,3 +54,9 @@ Output
     <tr><td>vm_id</td>                    <td>&#10004;</td>                     <td>string</td>                     <td>IOU VM UUID</td>                     </tr>
     </table>
 
+Sample session
+***************
+
+
+.. literalinclude:: ../../examples/post_projectsprojectidiouvms.txt
+

docs/api/v1/iou/projectsprojectidiouvmsvmid.rst

@@ -37,6 +37,12 @@ Output
     <tr><td>vm_id</td>                    <td>&#10004;</td>                     <td>string</td>                     <td>IOU VM UUID</td>                     </tr>
     </table>
 
+Sample session
+***************
+
+
+.. literalinclude:: ../../examples/get_projectsprojectidiouvmsvmid.txt
+
 
 PUT /v1/projects/**{project_id}**/iou/vms/**{vm_id}**
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -90,6 +96,12 @@ Output
     <tr><td>vm_id</td>                    <td>&#10004;</td>                     <td>string</td>                     <td>IOU VM UUID</td>                     </tr>
     </table>
 
+Sample session
+***************
+
+
+.. literalinclude:: ../../examples/put_projectsprojectidiouvmsvmid.txt
+
 
 DELETE /v1/projects/**{project_id}**/iou/vms/**{vm_id}**
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -106,3 +118,9 @@ Response status codes
 - **404**: Instance doesn't exist
 - **204**: Instance deleted
 
+Sample session
+***************
+
+
+.. literalinclude:: ../../examples/delete_projectsprojectidiouvmsvmid.txt
+

docs/api/v1/iou/projectsprojectidiouvmsvmidadaptersadapternumberdportsportnumberdnio.rst

@@ -11,8 +11,8 @@ Parameters
 **********
 - **project_id**: UUID for the project
 - **adapter_number**: Network adapter where the nio is located
-- **port_number**: Port where the nio should be added
 - **vm_id**: UUID for the instance
+- **port_number**: Port where the nio should be added
 
 Response status codes
 **********************
@@ -20,6 +20,12 @@ Response status codes
 - **201**: NIO created
 - **404**: Instance doesn't exist
 
+Sample session
+***************
+
+
+.. literalinclude:: ../../examples/post_projectsprojectidiouvmsvmidadaptersadapternumberdportsportnumberdnio.txt
+
 
 DELETE /v1/projects/**{project_id}**/iou/vms/**{vm_id}**/adapters/**{adapter_number:\d+}**/ports/**{port_number:\d+}**/nio
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -29,8 +35,8 @@ Parameters
 **********
 - **project_id**: UUID for the project
 - **adapter_number**: Network adapter where the nio is located
-- **port_number**: Port from where the nio should be removed
 - **vm_id**: UUID for the instance
+- **port_number**: Port from where the nio should be removed
 
 Response status codes
 **********************
@@ -38,3 +44,9 @@ Response status codes
 - **404**: Instance doesn't exist
 - **204**: NIO deleted
 
+Sample session
+***************
+
+
+.. literalinclude:: ../../examples/delete_projectsprojectidiouvmsvmidadaptersadapternumberdportsportnumberdnio.txt
+

docs/api/v1/iou/projectsprojectidiouvmsvmidadaptersadapternumberdportsportnumberdstartcapture.rst

@@ -11,8 +11,8 @@ Parameters
 **********
 - **project_id**: UUID for the project
 - **adapter_number**: Adapter to start a packet capture
-- **port_number**: Port on the adapter
 - **vm_id**: UUID for the instance
+- **port_number**: Port on the adapter
 
 Response status codes
 **********************
@@ -30,3 +30,9 @@ Input
     <tr><td>data_link_type</td>                    <td>&#10004;</td>                     <td>string</td>                     <td>PCAP data link type</td>                     </tr>
     </table>
 
+Sample session
+***************
+
+
+.. literalinclude:: ../../examples/post_projectsprojectidiouvmsvmidadaptersadapternumberdportsportnumberdstartcapture.txt
+

docs/api/v1/iou/projectsprojectidiouvmsvmidadaptersadapternumberdportsportnumberdstopcapture.rst

@@ -11,8 +11,8 @@ Parameters
 **********
 - **project_id**: UUID for the project
 - **adapter_number**: Adapter to stop a packet capture
-- **port_number**: Port on the adapter (always 0)
 - **vm_id**: UUID for the instance
+- **port_number**: Port on the adapter (always 0)
 
 Response status codes
 **********************
@@ -20,3 +20,9 @@ Response status codes
 - **404**: Instance doesn't exist
 - **204**: Capture stopped
 
+Sample session
+***************
+
+
+.. literalinclude:: ../../examples/post_projectsprojectidiouvmsvmidadaptersadapternumberdportsportnumberdstopcapture.txt
+

docs/api/v1/iou/projectsprojectidiouvmsvmidinitialconfig.rst

@@ -22,3 +22,9 @@ Output
     <tr><td>content</td>                    <td>&#10004;</td>                     <td>['string', 'null']</td>                     <td>Content of the initial configuration file</td>                     </tr>
     </table>
 
+Sample session
+***************
+
+
+.. literalinclude:: ../../examples/get_projectsprojectidiouvmsvmidinitialconfig.txt
+

docs/api/v1/iou/projectsprojectidiouvmsvmidreload.rst

@@ -18,3 +18,9 @@ Response status codes
 - **404**: Instance doesn't exist
 - **204**: Instance reloaded
 
+Sample session
+***************
+
+
+.. literalinclude:: ../../examples/post_projectsprojectidiouvmsvmidreload.txt
+

docs/api/v1/iou/projectsprojectidiouvmsvmidstart.rst

@@ -18,3 +18,9 @@ Response status codes
 - **404**: Instance doesn't exist
 - **204**: Instance started
 
+Sample session
+***************
+
+
+.. literalinclude:: ../../examples/post_projectsprojectidiouvmsvmidstart.txt
+

docs/api/v1/iou/projectsprojectidiouvmsvmidstop.rst

@@ -18,3 +18,9 @@ Response status codes
 - **404**: Instance doesn't exist
 - **204**: Instance stopped
 
+Sample session
+***************
+
+
+.. literalinclude:: ../../examples/post_projectsprojectidiouvmsvmidstop.txt
+

docs/api/v1/network.rst

@@ -5,4 +5,4 @@ Network
    :glob:
    :maxdepth: 2
 
-   api.network/*
+   network/*

docs/api/v1/network/interfaces.rst

@@ -11,3 +11,9 @@ Response status codes
 **********************
 - **200**: OK
 
+Sample session
+***************
+
+
+.. literalinclude:: ../../examples/get_interfaces.txt
+

docs/api/v1/network/portsudp.rst

@@ -11,3 +11,9 @@ Response status codes
 **********************
 - **201**: UDP port allocated
 
+Sample session
+***************
+
+
+.. literalinclude:: ../../examples/post_portsudp.txt
+

docs/api/v1/project.rst

@@ -5,4 +5,4 @@ Project
    :glob:
    :maxdepth: 2
 
-   api.project/*
+   project/*

docs/api/v1/project/projects.rst

@@ -34,3 +34,9 @@ Output
     <tr><td>temporary</td>                    <td>&#10004;</td>                     <td>boolean</td>                     <td>If project is a temporary project</td>                     </tr>
     </table>
 
+Sample session
+***************
+
+
+.. literalinclude:: ../../examples/post_projects.txt
+

docs/api/v1/project/projectsprojectid.rst

@@ -28,6 +28,12 @@ Output
     <tr><td>temporary</td>                    <td>&#10004;</td>                     <td>boolean</td>                     <td>If project is a temporary project</td>                     </tr>
     </table>
 
+Sample session
+***************
+
+
+.. literalinclude:: ../../examples/get_projectsprojectid.txt
+
 
 PUT /v1/projects/**{project_id}**
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -65,6 +71,12 @@ Output
     <tr><td>temporary</td>                    <td>&#10004;</td>                     <td>boolean</td>                     <td>If project is a temporary project</td>                     </tr>
     </table>
 
+Sample session
+***************
+
+
+.. literalinclude:: ../../examples/put_projectsprojectid.txt
+
 
 DELETE /v1/projects/**{project_id}**
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -79,3 +91,9 @@ Response status codes
 - **404**: The project doesn't exist
 - **204**: Changes have been written on disk
 
+Sample session
+***************
+
+
+.. literalinclude:: ../../examples/delete_projectsprojectid.txt
+

docs/api/v1/project/projectsprojectidclose.rst

@@ -16,3 +16,9 @@ Response status codes
 - **404**: The project doesn't exist
 - **204**: The project has been closed
 
+Sample session
+***************
+
+
+.. literalinclude:: ../../examples/post_projectsprojectidclose.txt
+

docs/api/v1/project/projectsprojectidcommit.rst

@@ -16,3 +16,9 @@ Response status codes
 - **404**: The project doesn't exist
 - **204**: Changes have been written on disk
 
+Sample session
+***************
+
+
+.. literalinclude:: ../../examples/post_projectsprojectidcommit.txt
+

docs/api/v1/qemu.rst

@@ -5,4 +5,4 @@ Qemu
    :glob:
    :maxdepth: 2
 
-   api.qemu/*
+   qemu/*

docs/api/v1/qemu/projectsprojectidqemuvms.rst

@@ -68,3 +68,9 @@ Output
     <tr><td>vm_id</td>                    <td>&#10004;</td>                     <td>string</td>                     <td>QEMU VM uuid</td>                     </tr>
     </table>
 
+Sample session
+***************
+
+
+.. literalinclude:: ../../examples/post_projectsprojectidqemuvms.txt
+

docs/api/v1/qemu/projectsprojectidqemuvmsvmid.rst

@@ -44,6 +44,12 @@ Output
     <tr><td>vm_id</td>                    <td>&#10004;</td>                     <td>string</td>                     <td>QEMU VM uuid</td>                     </tr>
     </table>
 
+Sample session
+***************
+
+
+.. literalinclude:: ../../examples/get_projectsprojectidqemuvmsvmid.txt
+
 
 PUT /v1/projects/**{project_id}**/qemu/vms/**{vm_id}**
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -111,6 +117,12 @@ Output
     <tr><td>vm_id</td>                    <td>&#10004;</td>                     <td>string</td>                     <td>QEMU VM uuid</td>                     </tr>
     </table>
 
+Sample session
+***************
+
+
+.. literalinclude:: ../../examples/put_projectsprojectidqemuvmsvmid.txt
+
 
 DELETE /v1/projects/**{project_id}**/qemu/vms/**{vm_id}**
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -127,3 +139,9 @@ Response status codes
 - **404**: Instance doesn't exist
 - **204**: Instance deleted
 
+Sample session
+***************
+
+
+.. literalinclude:: ../../examples/delete_projectsprojectidqemuvmsvmid.txt
+

docs/api/v1/qemu/projectsprojectidqemuvmsvmidadaptersadapternumberdportsportnumberdnio.rst

@@ -11,8 +11,8 @@ Parameters
 **********
 - **project_id**: UUID for the project
 - **adapter_number**: Network adapter where the nio is located
-- **port_number**: Port where the nio should be added
 - **vm_id**: UUID for the instance
+- **port_number**: Port where the nio should be added
 
 Response status codes
 **********************
@@ -20,6 +20,12 @@ Response status codes
 - **201**: NIO created
 - **404**: Instance doesn't exist
 
+Sample session
+***************
+
+
+.. literalinclude:: ../../examples/post_projectsprojectidqemuvmsvmidadaptersadapternumberdportsportnumberdnio.txt
+
 
 DELETE /v1/projects/**{project_id}**/qemu/vms/**{vm_id}**/adapters/**{adapter_number:\d+}**/ports/**{port_number:\d+}**/nio
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -29,8 +35,8 @@ Parameters
 **********
 - **project_id**: UUID for the project
 - **adapter_number**: Network adapter where the nio is located
-- **port_number**: Port from where the nio should be removed
 - **vm_id**: UUID for the instance
+- **port_number**: Port from where the nio should be removed
 
 Response status codes
 **********************
@@ -38,3 +44,9 @@ Response status codes
 - **404**: Instance doesn't exist
 - **204**: NIO deleted
 
+Sample session
+***************
+
+
+.. literalinclude:: ../../examples/delete_projectsprojectidqemuvmsvmidadaptersadapternumberdportsportnumberdnio.txt
+

docs/api/v1/qemu/projectsprojectidqemuvmsvmidreload.rst

@@ -18,3 +18,9 @@ Response status codes
 - **404**: Instance doesn't exist
 - **204**: Instance reloaded
 
+Sample session
+***************
+
+
+.. literalinclude:: ../../examples/post_projectsprojectidqemuvmsvmidreload.txt
+

docs/api/v1/qemu/projectsprojectidqemuvmsvmidresume.rst

@@ -18,3 +18,9 @@ Response status codes
 - **404**: Instance doesn't exist
 - **204**: Instance resumed
 
+Sample session
+***************
+
+
+.. literalinclude:: ../../examples/post_projectsprojectidqemuvmsvmidresume.txt
+

docs/api/v1/qemu/projectsprojectidqemuvmsvmidstart.rst

@@ -18,3 +18,9 @@ Response status codes
 - **404**: Instance doesn't exist
 - **204**: Instance started
 
+Sample session
+***************
+
+
+.. literalinclude:: ../../examples/post_projectsprojectidqemuvmsvmidstart.txt
+