From da00aa030a5f41df6c5540127545e045715d84c4 Mon Sep 17 00:00:00 2001 From: Julien Duponchelle Date: Mon, 30 Mar 2015 11:05:54 +0200 Subject: [PATCH] Fix missing /v1 in api documentation Fix #116 --- .../api/examples/delete_projectsprojectid.txt | 6 ++-- .../delete_projectsprojectidiouvmsvmid.txt | 6 ++-- ...ptersadapternumberdportsportnumberdnio.txt | 6 ++-- .../delete_projectsprojectidqemuvmsvmid.txt | 6 ++-- ...ptersadapternumberdportsportnumberdnio.txt | 6 ++-- ...ptersadapternumberdportsportnumberdnio.txt | 6 ++-- .../delete_projectsprojectidvpcsvmsvmid.txt | 6 ++-- ...ptersadapternumberdportsportnumberdnio.txt | 6 ++-- docs/api/examples/get_interfaces.txt | 28 +++++++++++++------ docs/api/examples/get_projectsprojectid.txt | 13 +++++---- .../get_projectsprojectidiouvmsvmid.txt | 14 ++++++---- ...ojectsprojectidiouvmsvmidinitialconfig.txt | 6 ++-- .../get_projectsprojectidqemuvmsvmid.txt | 15 +++++----- ...get_projectsprojectidvirtualboxvmsvmid.txt | 11 ++++---- .../get_projectsprojectidvpcsvmsvmid.txt | 8 +++--- docs/api/examples/get_qemubinaries.txt | 6 ++-- docs/api/examples/get_version.txt | 11 ++++---- docs/api/examples/post_configreload.txt | 13 +++++++++ docs/api/examples/post_portsudp.txt | 17 ----------- docs/api/examples/post_projects.txt | 19 +++++++------ .../examples/post_projectsprojectidclose.txt | 6 ++-- .../examples/post_projectsprojectidcommit.txt | 6 ++-- .../examples/post_projectsprojectidiouvms.txt | 20 +++++++------ ...ptersadapternumberdportsportnumberdnio.txt | 6 ++-- ...ternumberdportsportnumberdstartcapture.txt | 8 +++--- ...pternumberdportsportnumberdstopcapture.txt | 6 ++-- ...post_projectsprojectidiouvmsvmidreload.txt | 6 ++-- .../post_projectsprojectidiouvmsvmidstart.txt | 6 ++-- .../post_projectsprojectidiouvmsvmidstop.txt | 6 ++-- .../post_projectsprojectidportsudp.txt | 17 +++++++++++ .../post_projectsprojectidqemuvms.txt | 21 +++++++------- ...ptersadapternumberdportsportnumberdnio.txt | 6 ++-- ...ost_projectsprojectidqemuvmsvmidreload.txt | 6 ++-- ...ost_projectsprojectidqemuvmsvmidresume.txt | 6 ++-- ...post_projectsprojectidqemuvmsvmidstart.txt | 6 ++-- .../post_projectsprojectidqemuvmsvmidstop.txt | 6 ++-- ...st_projectsprojectidqemuvmsvmidsuspend.txt | 6 ++-- .../post_projectsprojectidvirtualboxvms.txt | 11 ++++---- ...ptersadapternumberdportsportnumberdnio.txt | 6 ++-- ...ojectsprojectidvirtualboxvmsvmidreload.txt | 6 ++-- ...ojectsprojectidvirtualboxvmsvmidresume.txt | 6 ++-- ...rojectsprojectidvirtualboxvmsvmidstart.txt | 6 ++-- ...projectsprojectidvirtualboxvmsvmidstop.txt | 6 ++-- ...jectsprojectidvirtualboxvmsvmidsuspend.txt | 6 ++-- .../post_projectsprojectidvpcsvms.txt | 8 +++--- ...ptersadapternumberdportsportnumberdnio.txt | 6 ++-- ...ost_projectsprojectidvpcsvmsvmidreload.txt | 6 ++-- ...post_projectsprojectidvpcsvmsvmidstart.txt | 6 ++-- .../post_projectsprojectidvpcsvmsvmidstop.txt | 6 ++-- docs/api/examples/post_version.txt | 12 ++++---- docs/api/examples/put_projectsprojectid.txt | 9 +++--- .../put_projectsprojectidiouvmsvmid.txt | 18 +++++++----- .../put_projectsprojectidqemuvmsvmid.txt | 23 +++++++-------- ...put_projectsprojectidvirtualboxvmsvmid.txt | 11 ++++---- .../put_projectsprojectidvpcsvmsvmid.txt | 8 +++--- docs/api/v1/config.rst | 8 ++++++ .../portsudp.rst => config/configreload.rst} | 11 ++++---- .../projectsprojectiddynamipsdevices.rst | 2 +- ...ojectsprojectiddynamipsdevicesdeviceid.rst | 6 ++-- ...mipsdevicesdeviceidportsportnumberdnio.rst | 8 +++--- ...esdeviceidportsportnumberdstartcapture.rst | 4 +-- ...cesdeviceidportsportnumberdstopcapture.rst | 4 +-- .../projectsprojectiddynamipsvms.rst | 4 +-- .../projectsprojectiddynamipsvmsvmid.rst | 13 ++++----- ...ptersadapternumberdportsportnumberdnio.rst | 8 +++--- ...ternumberdportsportnumberdstartcapture.rst | 4 +-- ...pternumberdportsportnumberdstopcapture.rst | 4 +-- ...ctsprojectiddynamipsvmsvmidconfigssave.rst | 15 ++++++++++ ...projectsprojectiddynamipsvmsvmidreload.rst | 2 +- ...projectsprojectiddynamipsvmsvmidresume.rst | 2 +- .../projectsprojectiddynamipsvmsvmidstart.rst | 2 +- .../projectsprojectiddynamipsvmsvmidstop.rst | 2 +- ...rojectsprojectiddynamipsvmsvmidsuspend.rst | 2 +- .../v1/network/projectsprojectidportsudp.rst | 24 ++++++++++++++++ docs/api/v1/project/projects.rst | 2 ++ docs/api/v1/project/projectsprojectid.rst | 3 ++ docs/api/v1/qemu/projectsprojectidqemuvms.rst | 8 ++++-- .../v1/qemu/projectsprojectidqemuvmsvmid.rst | 15 ++++++---- ...ptersadapternumberdportsportnumberdnio.rst | 12 ++++---- .../projectsprojectidqemuvmsvmidreload.rst | 2 +- .../projectsprojectidqemuvmsvmidresume.rst | 2 +- .../projectsprojectidqemuvmsvmidstart.rst | 2 +- .../qemu/projectsprojectidqemuvmsvmidstop.rst | 2 +- .../projectsprojectidqemuvmsvmidsuspend.rst | 2 +- docs/api/v1/server.rst | 8 ++++++ docs/api/v1/server/servershutdown.rst | 14 ++++++++++ docs/api/v1/version/version.rst | 3 ++ .../projectsprojectidvirtualboxvms.rst | 2 ++ .../projectsprojectidvirtualboxvmsvmid.rst | 9 ++++-- ...ptersadapternumberdportsportnumberdnio.rst | 10 +++---- ...ternumberdportsportnumberdstartcapture.rst | 4 +-- ...pternumberdportsportnumberdstopcapture.rst | 4 +-- ...ojectsprojectidvirtualboxvmsvmidreload.rst | 2 +- ...ojectsprojectidvirtualboxvmsvmidresume.rst | 2 +- ...rojectsprojectidvirtualboxvmsvmidstart.rst | 2 +- ...projectsprojectidvirtualboxvmsvmidstop.rst | 2 +- ...jectsprojectidvirtualboxvmsvmidsuspend.rst | 2 +- .../v1/vpcs/projectsprojectidvpcsvmsvmid.rst | 6 ++-- ...ptersadapternumberdportsportnumberdnio.rst | 8 +++--- .../projectsprojectidvpcsvmsvmidreload.rst | 2 +- .../projectsprojectidvpcsvmsvmidstart.rst | 2 +- .../vpcs/projectsprojectidvpcsvmsvmidstop.rst | 2 +- tests/handlers/api/base.py | 8 +++--- 103 files changed, 455 insertions(+), 325 deletions(-) create mode 100644 docs/api/examples/post_configreload.txt delete mode 100644 docs/api/examples/post_portsudp.txt create mode 100644 docs/api/examples/post_projectsprojectidportsudp.txt create mode 100644 docs/api/v1/config.rst rename docs/api/v1/{network/portsudp.rst => config/configreload.rst} (64%) create mode 100644 docs/api/v1/dynamips_vm/projectsprojectiddynamipsvmsvmidconfigssave.rst create mode 100644 docs/api/v1/network/projectsprojectidportsudp.rst create mode 100644 docs/api/v1/server.rst create mode 100644 docs/api/v1/server/servershutdown.rst diff --git a/docs/api/examples/delete_projectsprojectid.txt b/docs/api/examples/delete_projectsprojectid.txt index 7d59321b..3ec2f35c 100644 --- a/docs/api/examples/delete_projectsprojectid.txt +++ b/docs/api/examples/delete_projectsprojectid.txt @@ -1,6 +1,6 @@ -curl -i -X DELETE 'http://localhost:8000/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80' +curl -i -X DELETE 'http://localhost:8000/v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80' -DELETE /projects/a1e920ca-338a-4e9f-b363-aa607b09dd80 HTTP/1.1 +DELETE /v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80 HTTP/1.1 @@ -8,6 +8,6 @@ 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 +SERVER: Python/3.4 GNS3/1.3.0.dev3 X-ROUTE: /v1/projects/{project_id} diff --git a/docs/api/examples/delete_projectsprojectidiouvmsvmid.txt b/docs/api/examples/delete_projectsprojectidiouvmsvmid.txt index c47266ee..7e9bb382 100644 --- a/docs/api/examples/delete_projectsprojectidiouvmsvmid.txt +++ b/docs/api/examples/delete_projectsprojectidiouvmsvmid.txt @@ -1,6 +1,6 @@ -curl -i -X DELETE 'http://localhost:8000/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/iou/vms/ac98c05c-dbf1-4157-8f4c-6a0319a0bcdc' +curl -i -X DELETE 'http://localhost:8000/v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/iou/vms/ce8ff042-5408-4601-a0fe-4854afee7080' -DELETE /projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/iou/vms/ac98c05c-dbf1-4157-8f4c-6a0319a0bcdc HTTP/1.1 +DELETE /v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/iou/vms/ce8ff042-5408-4601-a0fe-4854afee7080 HTTP/1.1 @@ -8,6 +8,6 @@ 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 +SERVER: Python/3.4 GNS3/1.3.0.dev3 X-ROUTE: /v1/projects/{project_id}/iou/vms/{vm_id} diff --git a/docs/api/examples/delete_projectsprojectidiouvmsvmidadaptersadapternumberdportsportnumberdnio.txt b/docs/api/examples/delete_projectsprojectidiouvmsvmidadaptersadapternumberdportsportnumberdnio.txt index 289cdd57..2c0472a6 100644 --- a/docs/api/examples/delete_projectsprojectidiouvmsvmidadaptersadapternumberdportsportnumberdnio.txt +++ b/docs/api/examples/delete_projectsprojectidiouvmsvmidadaptersadapternumberdportsportnumberdnio.txt @@ -1,6 +1,6 @@ -curl -i -X DELETE 'http://localhost:8000/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/iou/vms/acf7667f-91d4-4be5-9eec-f453783bb983/adapters/1/ports/0/nio' +curl -i -X DELETE 'http://localhost:8000/v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/iou/vms/fb4353bb-ead4-42f0-8f51-d79c43deb019/adapters/1/ports/0/nio' -DELETE /projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/iou/vms/acf7667f-91d4-4be5-9eec-f453783bb983/adapters/1/ports/0/nio HTTP/1.1 +DELETE /v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/iou/vms/fb4353bb-ead4-42f0-8f51-d79c43deb019/adapters/1/ports/0/nio HTTP/1.1 @@ -8,6 +8,6 @@ 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 +SERVER: Python/3.4 GNS3/1.3.0.dev3 X-ROUTE: /v1/projects/{project_id}/iou/vms/{vm_id}/adapters/{adapter_number:\d+}/ports/{port_number:\d+}/nio diff --git a/docs/api/examples/delete_projectsprojectidqemuvmsvmid.txt b/docs/api/examples/delete_projectsprojectidqemuvmsvmid.txt index aee9ddd3..1ccdfe6a 100644 --- a/docs/api/examples/delete_projectsprojectidqemuvmsvmid.txt +++ b/docs/api/examples/delete_projectsprojectidqemuvmsvmid.txt @@ -1,6 +1,6 @@ -curl -i -X DELETE 'http://localhost:8000/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/qemu/vms/da298f63-4d5b-44a7-8672-ec6642009725' +curl -i -X DELETE 'http://localhost:8000/v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/qemu/vms/fa2a7032-3c3a-4017-9ddd-ee2065f48b12' -DELETE /projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/qemu/vms/da298f63-4d5b-44a7-8672-ec6642009725 HTTP/1.1 +DELETE /v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/qemu/vms/fa2a7032-3c3a-4017-9ddd-ee2065f48b12 HTTP/1.1 @@ -8,6 +8,6 @@ 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 +SERVER: Python/3.4 GNS3/1.3.0.dev3 X-ROUTE: /v1/projects/{project_id}/qemu/vms/{vm_id} diff --git a/docs/api/examples/delete_projectsprojectidqemuvmsvmidadaptersadapternumberdportsportnumberdnio.txt b/docs/api/examples/delete_projectsprojectidqemuvmsvmidadaptersadapternumberdportsportnumberdnio.txt index 2648effe..a98af776 100644 --- a/docs/api/examples/delete_projectsprojectidqemuvmsvmidadaptersadapternumberdportsportnumberdnio.txt +++ b/docs/api/examples/delete_projectsprojectidqemuvmsvmidadaptersadapternumberdportsportnumberdnio.txt @@ -1,6 +1,6 @@ -curl -i -X DELETE 'http://localhost:8000/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/qemu/vms/75fa07c2-fb3d-4a19-815d-2dee5aa5325c/adapters/1/ports/0/nio' +curl -i -X DELETE 'http://localhost:8000/v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/qemu/vms/3c00f532-1239-4706-86cf-ea143c06e8e8/adapters/1/ports/0/nio' -DELETE /projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/qemu/vms/75fa07c2-fb3d-4a19-815d-2dee5aa5325c/adapters/1/ports/0/nio HTTP/1.1 +DELETE /v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/qemu/vms/3c00f532-1239-4706-86cf-ea143c06e8e8/adapters/1/ports/0/nio HTTP/1.1 @@ -8,6 +8,6 @@ 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 +SERVER: Python/3.4 GNS3/1.3.0.dev3 X-ROUTE: /v1/projects/{project_id}/qemu/vms/{vm_id}/adapters/{adapter_number:\d+}/ports/{port_number:\d+}/nio diff --git a/docs/api/examples/delete_projectsprojectidvirtualboxvmsvmidadaptersadapternumberdportsportnumberdnio.txt b/docs/api/examples/delete_projectsprojectidvirtualboxvmsvmidadaptersadapternumberdportsportnumberdnio.txt index ecefe5ab..6331d55b 100644 --- a/docs/api/examples/delete_projectsprojectidvirtualboxvmsvmidadaptersadapternumberdportsportnumberdnio.txt +++ b/docs/api/examples/delete_projectsprojectidvirtualboxvmsvmidadaptersadapternumberdportsportnumberdnio.txt @@ -1,6 +1,6 @@ -curl -i -X DELETE 'http://localhost:8000/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/virtualbox/vms/c99f4293-b8b1-40a6-8535-014c4afc2fe7/adapters/0/ports/0/nio' +curl -i -X DELETE 'http://localhost:8000/v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/virtualbox/vms/8d1eec7a-d44b-4c3f-8cc8-f48d41cb1c18/adapters/0/ports/0/nio' -DELETE /projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/virtualbox/vms/c99f4293-b8b1-40a6-8535-014c4afc2fe7/adapters/0/ports/0/nio HTTP/1.1 +DELETE /v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/virtualbox/vms/8d1eec7a-d44b-4c3f-8cc8-f48d41cb1c18/adapters/0/ports/0/nio HTTP/1.1 @@ -8,6 +8,6 @@ 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 +SERVER: Python/3.4 GNS3/1.3.0.dev3 X-ROUTE: /v1/projects/{project_id}/virtualbox/vms/{vm_id}/adapters/{adapter_number:\d+}/ports/{port_number:\d+}/nio diff --git a/docs/api/examples/delete_projectsprojectidvpcsvmsvmid.txt b/docs/api/examples/delete_projectsprojectidvpcsvmsvmid.txt index 44002739..5af0bd3c 100644 --- a/docs/api/examples/delete_projectsprojectidvpcsvmsvmid.txt +++ b/docs/api/examples/delete_projectsprojectidvpcsvmsvmid.txt @@ -1,6 +1,6 @@ -curl -i -X DELETE 'http://localhost:8000/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/vpcs/vms/879f1789-bde0-4e64-ac68-f61a9b114347' +curl -i -X DELETE 'http://localhost:8000/v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/vpcs/vms/b5582f24-886f-47f4-8037-68fab299f55e' -DELETE /projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/vpcs/vms/879f1789-bde0-4e64-ac68-f61a9b114347 HTTP/1.1 +DELETE /v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/vpcs/vms/b5582f24-886f-47f4-8037-68fab299f55e HTTP/1.1 @@ -8,6 +8,6 @@ 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 +SERVER: Python/3.4 GNS3/1.3.0.dev3 X-ROUTE: /v1/projects/{project_id}/vpcs/vms/{vm_id} diff --git a/docs/api/examples/delete_projectsprojectidvpcsvmsvmidadaptersadapternumberdportsportnumberdnio.txt b/docs/api/examples/delete_projectsprojectidvpcsvmsvmidadaptersadapternumberdportsportnumberdnio.txt index edc3f792..47f15bbc 100644 --- a/docs/api/examples/delete_projectsprojectidvpcsvmsvmidadaptersadapternumberdportsportnumberdnio.txt +++ b/docs/api/examples/delete_projectsprojectidvpcsvmsvmidadaptersadapternumberdportsportnumberdnio.txt @@ -1,6 +1,6 @@ -curl -i -X DELETE 'http://localhost:8000/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/vpcs/vms/5238c683-bb17-49f2-8796-a60668fc5955/adapters/0/ports/0/nio' +curl -i -X DELETE 'http://localhost:8000/v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/vpcs/vms/03960920-2b9f-4b04-82b0-6f751630e10d/adapters/0/ports/0/nio' -DELETE /projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/vpcs/vms/5238c683-bb17-49f2-8796-a60668fc5955/adapters/0/ports/0/nio HTTP/1.1 +DELETE /v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/vpcs/vms/03960920-2b9f-4b04-82b0-6f751630e10d/adapters/0/ports/0/nio HTTP/1.1 @@ -8,6 +8,6 @@ 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 +SERVER: Python/3.4 GNS3/1.3.0.dev3 X-ROUTE: /v1/projects/{project_id}/vpcs/vms/{vm_id}/adapters/{adapter_number:\d+}/ports/{port_number:\d+}/nio diff --git a/docs/api/examples/get_interfaces.txt b/docs/api/examples/get_interfaces.txt index a34c7bc5..335642d3 100644 --- a/docs/api/examples/get_interfaces.txt +++ b/docs/api/examples/get_interfaces.txt @@ -1,15 +1,15 @@ -curl -i -X GET 'http://localhost:8000/interfaces' +curl -i -X GET 'http://localhost:8000/v1/interfaces' -GET /interfaces HTTP/1.1 +GET /v1/interfaces HTTP/1.1 HTTP/1.1 200 CONNECTION: keep-alive -CONTENT-LENGTH: 520 +CONTENT-LENGTH: 718 CONTENT-TYPE: application/json DATE: Thu, 08 Jan 2015 16:09:15 GMT -SERVER: Python/3.4 GNS3/1.3.dev1 +SERVER: Python/3.4 GNS3/1.3.0.dev3 X-ROUTE: /v1/interfaces [ @@ -33,10 +33,6 @@ X-ROUTE: /v1/interfaces "id": "en1", "name": "en1" }, - { - "id": "fw0", - "name": "fw0" - }, { "id": "en2", "name": "en2" @@ -45,8 +41,24 @@ X-ROUTE: /v1/interfaces "id": "p2p0", "name": "p2p0" }, + { + "id": "fw0", + "name": "fw0" + }, { "id": "bridge0", "name": "bridge0" + }, + { + "id": "vboxnet0", + "name": "vboxnet0" + }, + { + "id": "vboxnet1", + "name": "vboxnet1" + }, + { + "id": "vboxnet2", + "name": "vboxnet2" } ] diff --git a/docs/api/examples/get_projectsprojectid.txt b/docs/api/examples/get_projectsprojectid.txt index 464d9f9e..e5637c62 100644 --- a/docs/api/examples/get_projectsprojectid.txt +++ b/docs/api/examples/get_projectsprojectid.txt @@ -1,20 +1,21 @@ -curl -i -X GET 'http://localhost:8000/projects/00010203-0405-0607-0809-0a0b0c0d0e02' +curl -i -X GET 'http://localhost:8000/v1/projects/00010203-0405-0607-0809-0a0b0c0d0e02' -GET /projects/00010203-0405-0607-0809-0a0b0c0d0e02 HTTP/1.1 +GET /v1/projects/00010203-0405-0607-0809-0a0b0c0d0e02 HTTP/1.1 HTTP/1.1 200 CONNECTION: keep-alive -CONTENT-LENGTH: 277 +CONTENT-LENGTH: 297 CONTENT-TYPE: application/json DATE: Thu, 08 Jan 2015 16:09:15 GMT -SERVER: Python/3.4 GNS3/1.3.dev1 +SERVER: Python/3.4 GNS3/1.3.0.dev3 X-ROUTE: /v1/projects/{project_id} { - "location": "/var/folders/3s/r2wbv07n7wg4vrsn874lmxxh0000gn/T/tmpju7ztx9a", - "path": "/var/folders/3s/r2wbv07n7wg4vrsn874lmxxh0000gn/T/tmpju7ztx9a/00010203-0405-0607-0809-0a0b0c0d0e02", + "location": "/var/folders/3s/r2wbv07n7wg4vrsn874lmxxh0000gn/T/tmp0mlxzdj2", + "name": "test", + "path": "/var/folders/3s/r2wbv07n7wg4vrsn874lmxxh0000gn/T/tmp0mlxzdj2/00010203-0405-0607-0809-0a0b0c0d0e02", "project_id": "00010203-0405-0607-0809-0a0b0c0d0e02", "temporary": false } diff --git a/docs/api/examples/get_projectsprojectidiouvmsvmid.txt b/docs/api/examples/get_projectsprojectidiouvmsvmid.txt index d85e9376..71eeccf6 100644 --- a/docs/api/examples/get_projectsprojectidiouvmsvmid.txt +++ b/docs/api/examples/get_projectsprojectidiouvmsvmid.txt @@ -1,27 +1,29 @@ -curl -i -X GET 'http://localhost:8000/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/iou/vms/c5c0075d-0b10-4401-8bed-d9897814237c' +curl -i -X GET 'http://localhost:8000/v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/iou/vms/c73476fe-e744-4aeb-8f55-add8e51d2917' -GET /projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/iou/vms/c5c0075d-0b10-4401-8bed-d9897814237c HTTP/1.1 +GET /v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/iou/vms/c73476fe-e744-4aeb-8f55-add8e51d2917 HTTP/1.1 HTTP/1.1 200 CONNECTION: keep-alive -CONTENT-LENGTH: 409 +CONTENT-LENGTH: 386 CONTENT-TYPE: application/json DATE: Thu, 08 Jan 2015 16:09:15 GMT -SERVER: Python/3.4 GNS3/1.3.dev1 +SERVER: Python/3.4 GNS3/1.3.0.dev3 X-ROUTE: /v1/projects/{project_id}/iou/vms/{vm_id} { "console": 2000, "ethernet_adapters": 2, "initial_config": null, + "iourc_path": null, "l1_keepalives": false, "name": "PC TEST 1", "nvram": 128, - "path": "/private/var/folders/3s/r2wbv07n7wg4vrsn874lmxxh0000gn/T/pytest-3783/test_iou_get0/iou.bin", + "path": "iou.bin", "project_id": "a1e920ca-338a-4e9f-b363-aa607b09dd80", "ram": 256, "serial_adapters": 2, - "vm_id": "c5c0075d-0b10-4401-8bed-d9897814237c" + "use_default_iou_values": true, + "vm_id": "c73476fe-e744-4aeb-8f55-add8e51d2917" } diff --git a/docs/api/examples/get_projectsprojectidiouvmsvmidinitialconfig.txt b/docs/api/examples/get_projectsprojectidiouvmsvmidinitialconfig.txt index 44f27589..a2bf6935 100644 --- a/docs/api/examples/get_projectsprojectidiouvmsvmidinitialconfig.txt +++ b/docs/api/examples/get_projectsprojectidiouvmsvmidinitialconfig.txt @@ -1,6 +1,6 @@ -curl -i -X GET 'http://localhost:8000/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/iou/vms/f7220f9c-3334-43e3-9ef4-37f09ba6fcab/initial_config' +curl -i -X GET 'http://localhost:8000/v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/iou/vms/4deb685c-afd4-4dc6-93bf-1770846950a9/initial_config' -GET /projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/iou/vms/f7220f9c-3334-43e3-9ef4-37f09ba6fcab/initial_config HTTP/1.1 +GET /v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/iou/vms/4deb685c-afd4-4dc6-93bf-1770846950a9/initial_config HTTP/1.1 @@ -9,7 +9,7 @@ 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 +SERVER: Python/3.4 GNS3/1.3.0.dev3 X-ROUTE: /v1/projects/{project_id}/iou/vms/{vm_id}/initial_config { diff --git a/docs/api/examples/get_projectsprojectidqemuvmsvmid.txt b/docs/api/examples/get_projectsprojectidqemuvmsvmid.txt index 553d0eb6..da14d69b 100644 --- a/docs/api/examples/get_projectsprojectidqemuvmsvmid.txt +++ b/docs/api/examples/get_projectsprojectidqemuvmsvmid.txt @@ -1,15 +1,15 @@ -curl -i -X GET 'http://localhost:8000/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/qemu/vms/4532d770-23a0-4858-bbab-d8a8b3a17deb' +curl -i -X GET 'http://localhost:8000/v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/qemu/vms/aff4ab99-85c1-4892-8759-c7ed34aafd36' -GET /projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/qemu/vms/4532d770-23a0-4858-bbab-d8a8b3a17deb HTTP/1.1 +GET /v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/qemu/vms/aff4ab99-85c1-4892-8759-c7ed34aafd36 HTTP/1.1 HTTP/1.1 200 CONNECTION: keep-alive -CONTENT-LENGTH: 566 +CONTENT-LENGTH: 597 CONTENT-TYPE: application/json DATE: Thu, 08 Jan 2015 16:09:15 GMT -SERVER: Python/3.4 GNS3/1.3.dev1 +SERVER: Python/3.4 GNS3/1.3.0.dev3 X-ROUTE: /v1/projects/{project_id}/qemu/vms/{vm_id} { @@ -19,16 +19,17 @@ X-ROUTE: /v1/projects/{project_id}/qemu/vms/{vm_id} "cpu_throttling": 0, "hda_disk_image": "", "hdb_disk_image": "", + "hdc_disk_image": "", + "hdd_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/tmph25p8xei/qemu_x42", + "qemu_path": "/var/folders/3s/r2wbv07n7wg4vrsn874lmxxh0000gn/T/tmpyllkr06h/qemu_x42", "ram": 256, - "vm_id": "4532d770-23a0-4858-bbab-d8a8b3a17deb" + "vm_id": "aff4ab99-85c1-4892-8759-c7ed34aafd36" } diff --git a/docs/api/examples/get_projectsprojectidvirtualboxvmsvmid.txt b/docs/api/examples/get_projectsprojectidvirtualboxvmsvmid.txt index e2d9cc0f..dfa85f93 100644 --- a/docs/api/examples/get_projectsprojectidvirtualboxvmsvmid.txt +++ b/docs/api/examples/get_projectsprojectidvirtualboxvmsvmid.txt @@ -1,15 +1,15 @@ -curl -i -X GET 'http://localhost:8000/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/virtualbox/vms/f526503a-8d24-4513-a5e3-1ebf4159aa70' +curl -i -X GET 'http://localhost:8000/v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/virtualbox/vms/5f2e526e-1641-46ef-8963-785c4035f695' -GET /projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/virtualbox/vms/f526503a-8d24-4513-a5e3-1ebf4159aa70 HTTP/1.1 +GET /v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/virtualbox/vms/5f2e526e-1641-46ef-8963-785c4035f695 HTTP/1.1 HTTP/1.1 200 CONNECTION: keep-alive -CONTENT-LENGTH: 347 +CONTENT-LENGTH: 361 CONTENT-TYPE: application/json DATE: Thu, 08 Jan 2015 16:09:15 GMT -SERVER: Python/3.4 GNS3/1.3.dev1 +SERVER: Python/3.4 GNS3/1.3.0.dev3 X-ROUTE: /v1/projects/{project_id}/virtualbox/vms/{vm_id} { @@ -20,7 +20,8 @@ X-ROUTE: /v1/projects/{project_id}/virtualbox/vms/{vm_id} "headless": false, "name": "VMTEST", "project_id": "a1e920ca-338a-4e9f-b363-aa607b09dd80", + "ram": 0, "use_any_adapter": false, - "vm_id": "f526503a-8d24-4513-a5e3-1ebf4159aa70", + "vm_id": "5f2e526e-1641-46ef-8963-785c4035f695", "vmname": "VMTEST" } diff --git a/docs/api/examples/get_projectsprojectidvpcsvmsvmid.txt b/docs/api/examples/get_projectsprojectidvpcsvmsvmid.txt index c3530f18..c35b8828 100644 --- a/docs/api/examples/get_projectsprojectidvpcsvmsvmid.txt +++ b/docs/api/examples/get_projectsprojectidvpcsvmsvmid.txt @@ -1,6 +1,6 @@ -curl -i -X GET 'http://localhost:8000/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/vpcs/vms/6f3c227f-86f5-4f54-bc4b-74597744b904' +curl -i -X GET 'http://localhost:8000/v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/vpcs/vms/b0fb2fe2-577c-4c2c-a675-88159935d854' -GET /projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/vpcs/vms/6f3c227f-86f5-4f54-bc4b-74597744b904 HTTP/1.1 +GET /v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/vpcs/vms/b0fb2fe2-577c-4c2c-a675-88159935d854 HTTP/1.1 @@ -9,7 +9,7 @@ CONNECTION: keep-alive CONTENT-LENGTH: 220 CONTENT-TYPE: application/json DATE: Thu, 08 Jan 2015 16:09:15 GMT -SERVER: Python/3.4 GNS3/1.3.dev1 +SERVER: Python/3.4 GNS3/1.3.0.dev3 X-ROUTE: /v1/projects/{project_id}/vpcs/vms/{vm_id} { @@ -18,5 +18,5 @@ X-ROUTE: /v1/projects/{project_id}/vpcs/vms/{vm_id} "project_id": "a1e920ca-338a-4e9f-b363-aa607b09dd80", "startup_script": null, "startup_script_path": null, - "vm_id": "6f3c227f-86f5-4f54-bc4b-74597744b904" + "vm_id": "b0fb2fe2-577c-4c2c-a675-88159935d854" } diff --git a/docs/api/examples/get_qemubinaries.txt b/docs/api/examples/get_qemubinaries.txt index d65c7681..6f6afae9 100644 --- a/docs/api/examples/get_qemubinaries.txt +++ b/docs/api/examples/get_qemubinaries.txt @@ -1,6 +1,6 @@ -curl -i -X GET 'http://localhost:8000/qemu/binaries' +curl -i -X GET 'http://localhost:8000/v1/qemu/binaries' -GET /qemu/binaries HTTP/1.1 +GET /v1/qemu/binaries HTTP/1.1 @@ -9,7 +9,7 @@ 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 +SERVER: Python/3.4 GNS3/1.3.0.dev3 X-ROUTE: /v1/qemu/binaries [ diff --git a/docs/api/examples/get_version.txt b/docs/api/examples/get_version.txt index 88017034..608636d5 100644 --- a/docs/api/examples/get_version.txt +++ b/docs/api/examples/get_version.txt @@ -1,17 +1,18 @@ -curl -i -X GET 'http://localhost:8000/version' +curl -i -X GET 'http://localhost:8000/v1/version' -GET /version HTTP/1.1 +GET /v1/version HTTP/1.1 HTTP/1.1 200 CONNECTION: keep-alive -CONTENT-LENGTH: 29 +CONTENT-LENGTH: 50 CONTENT-TYPE: application/json DATE: Thu, 08 Jan 2015 16:09:15 GMT -SERVER: Python/3.4 GNS3/1.3.dev1 +SERVER: Python/3.4 GNS3/1.3.0.dev3 X-ROUTE: /v1/version { - "version": "1.3.dev1" + "local": true, + "version": "1.3.0.dev3" } diff --git a/docs/api/examples/post_configreload.txt b/docs/api/examples/post_configreload.txt new file mode 100644 index 00000000..81568386 --- /dev/null +++ b/docs/api/examples/post_configreload.txt @@ -0,0 +1,13 @@ +curl -i -X POST 'http://localhost:8000/v1/config/reload' -d '{}' + +POST /v1/config/reload HTTP/1.1 +{} + + +HTTP/1.1 201 +CONNECTION: keep-alive +CONTENT-LENGTH: 0 +DATE: Thu, 08 Jan 2015 16:09:15 GMT +SERVER: Python/3.4 GNS3/1.3.0.dev3 +X-ROUTE: /v1/config/reload + diff --git a/docs/api/examples/post_portsudp.txt b/docs/api/examples/post_portsudp.txt deleted file mode 100644 index 3be4b74c..00000000 --- a/docs/api/examples/post_portsudp.txt +++ /dev/null @@ -1,17 +0,0 @@ -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 -} diff --git a/docs/api/examples/post_projects.txt b/docs/api/examples/post_projects.txt index 416dbed2..ef781c6b 100644 --- a/docs/api/examples/post_projects.txt +++ b/docs/api/examples/post_projects.txt @@ -1,20 +1,23 @@ -curl -i -X POST 'http://localhost:8000/projects' -d '{}' +curl -i -X POST 'http://localhost:8000/v1/projects' -d '{"name": "test"}' -POST /projects HTTP/1.1 -{} +POST /v1/projects HTTP/1.1 +{ + "name": "test" +} HTTP/1.1 201 CONNECTION: keep-alive -CONTENT-LENGTH: 277 +CONTENT-LENGTH: 297 CONTENT-TYPE: application/json DATE: Thu, 08 Jan 2015 16:09:15 GMT -SERVER: Python/3.4 GNS3/1.3.dev1 +SERVER: Python/3.4 GNS3/1.3.0.dev3 X-ROUTE: /v1/projects { - "location": "/var/folders/3s/r2wbv07n7wg4vrsn874lmxxh0000gn/T/tmp4s49s4hy", - "path": "/var/folders/3s/r2wbv07n7wg4vrsn874lmxxh0000gn/T/tmp4s49s4hy/119348c0-fa80-4386-bf1e-b00755c9c6b4", - "project_id": "119348c0-fa80-4386-bf1e-b00755c9c6b4", + "location": "/var/folders/3s/r2wbv07n7wg4vrsn874lmxxh0000gn/T/tmp2mcnd0d3", + "name": "test", + "path": "/var/folders/3s/r2wbv07n7wg4vrsn874lmxxh0000gn/T/tmp2mcnd0d3/e61f239c-1cfd-45ac-88da-51ae6a1e92aa", + "project_id": "e61f239c-1cfd-45ac-88da-51ae6a1e92aa", "temporary": false } diff --git a/docs/api/examples/post_projectsprojectidclose.txt b/docs/api/examples/post_projectsprojectidclose.txt index b42beff6..59d1fbb3 100644 --- a/docs/api/examples/post_projectsprojectidclose.txt +++ b/docs/api/examples/post_projectsprojectidclose.txt @@ -1,6 +1,6 @@ -curl -i -X POST 'http://localhost:8000/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/close' -d '{}' +curl -i -X POST 'http://localhost:8000/v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/close' -d '{}' -POST /projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/close HTTP/1.1 +POST /v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/close HTTP/1.1 {} @@ -8,6 +8,6 @@ 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 +SERVER: Python/3.4 GNS3/1.3.0.dev3 X-ROUTE: /v1/projects/{project_id}/close diff --git a/docs/api/examples/post_projectsprojectidcommit.txt b/docs/api/examples/post_projectsprojectidcommit.txt index 261c616f..05caa36c 100644 --- a/docs/api/examples/post_projectsprojectidcommit.txt +++ b/docs/api/examples/post_projectsprojectidcommit.txt @@ -1,6 +1,6 @@ -curl -i -X POST 'http://localhost:8000/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/commit' -d '{}' +curl -i -X POST 'http://localhost:8000/v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/commit' -d '{}' -POST /projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/commit HTTP/1.1 +POST /v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/commit HTTP/1.1 {} @@ -8,6 +8,6 @@ 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 +SERVER: Python/3.4 GNS3/1.3.0.dev3 X-ROUTE: /v1/projects/{project_id}/commit diff --git a/docs/api/examples/post_projectsprojectidiouvms.txt b/docs/api/examples/post_projectsprojectidiouvms.txt index 2e254f47..ca9ea78f 100644 --- a/docs/api/examples/post_projectsprojectidiouvms.txt +++ b/docs/api/examples/post_projectsprojectidiouvms.txt @@ -1,36 +1,40 @@ -curl -i -X POST 'http://localhost:8000/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/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-3783/test_iou_create_with_params0/iou.bin", "ram": 1024, "serial_adapters": 4}' +curl -i -X POST 'http://localhost:8000/v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/iou/vms' -d '{"ethernet_adapters": 0, "initial_config_content": "hostname test", "iourc_content": "test", "l1_keepalives": true, "name": "PC TEST 1", "nvram": 512, "path": "/private/var/folders/3s/r2wbv07n7wg4vrsn874lmxxh0000gn/T/pytest-4332/test_iou_create_with_params0/iou.bin", "ram": 1024, "serial_adapters": 4, "use_default_iou_values": true}' -POST /projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/iou/vms HTTP/1.1 +POST /v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/iou/vms HTTP/1.1 { "ethernet_adapters": 0, "initial_config_content": "hostname test", + "iourc_content": "test", "l1_keepalives": true, "name": "PC TEST 1", "nvram": 512, - "path": "/private/var/folders/3s/r2wbv07n7wg4vrsn874lmxxh0000gn/T/pytest-3783/test_iou_create_with_params0/iou.bin", + "path": "/private/var/folders/3s/r2wbv07n7wg4vrsn874lmxxh0000gn/T/pytest-4332/test_iou_create_with_params0/iou.bin", "ram": 1024, - "serial_adapters": 4 + "serial_adapters": 4, + "use_default_iou_values": true } HTTP/1.1 201 CONNECTION: keep-alive -CONTENT-LENGTH: 440 +CONTENT-LENGTH: 466 CONTENT-TYPE: application/json DATE: Thu, 08 Jan 2015 16:09:15 GMT -SERVER: Python/3.4 GNS3/1.3.dev1 +SERVER: Python/3.4 GNS3/1.3.0.dev3 X-ROUTE: /v1/projects/{project_id}/iou/vms { "console": 2000, "ethernet_adapters": 0, "initial_config": "initial-config.cfg", + "iourc_path": "/var/folders/3s/r2wbv07n7wg4vrsn874lmxxh0000gn/T/tmpmnf8_vaz/iourc", "l1_keepalives": true, "name": "PC TEST 1", "nvram": 512, - "path": "/private/var/folders/3s/r2wbv07n7wg4vrsn874lmxxh0000gn/T/pytest-3783/test_iou_create_with_params0/iou.bin", + "path": "iou.bin", "project_id": "a1e920ca-338a-4e9f-b363-aa607b09dd80", "ram": 1024, "serial_adapters": 4, - "vm_id": "3c02aa01-46d2-4a62-97d6-dc5829afdf39" + "use_default_iou_values": true, + "vm_id": "ffb44d02-75a0-4cd3-b24a-bdb7b71efbd8" } diff --git a/docs/api/examples/post_projectsprojectidiouvmsvmidadaptersadapternumberdportsportnumberdnio.txt b/docs/api/examples/post_projectsprojectidiouvmsvmidadaptersadapternumberdportsportnumberdnio.txt index b8cc08d9..5a162cd0 100644 --- a/docs/api/examples/post_projectsprojectidiouvmsvmidadaptersadapternumberdportsportnumberdnio.txt +++ b/docs/api/examples/post_projectsprojectidiouvmsvmidadaptersadapternumberdportsportnumberdnio.txt @@ -1,6 +1,6 @@ -curl -i -X POST 'http://localhost:8000/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/iou/vms/7f758868-46e1-4ef5-accc-f8e939a12471/adapters/1/ports/0/nio' -d '{"ethernet_device": "eth0", "type": "nio_generic_ethernet"}' +curl -i -X POST 'http://localhost:8000/v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/iou/vms/e453158e-719d-404a-ba1e-616ba91ddad3/adapters/1/ports/0/nio' -d '{"ethernet_device": "eth0", "type": "nio_generic_ethernet"}' -POST /projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/iou/vms/7f758868-46e1-4ef5-accc-f8e939a12471/adapters/1/ports/0/nio HTTP/1.1 +POST /v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/iou/vms/e453158e-719d-404a-ba1e-616ba91ddad3/adapters/1/ports/0/nio HTTP/1.1 { "ethernet_device": "eth0", "type": "nio_generic_ethernet" @@ -12,7 +12,7 @@ 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 +SERVER: Python/3.4 GNS3/1.3.0.dev3 X-ROUTE: /v1/projects/{project_id}/iou/vms/{vm_id}/adapters/{adapter_number:\d+}/ports/{port_number:\d+}/nio { diff --git a/docs/api/examples/post_projectsprojectidiouvmsvmidadaptersadapternumberdportsportnumberdstartcapture.txt b/docs/api/examples/post_projectsprojectidiouvmsvmidadaptersadapternumberdportsportnumberdstartcapture.txt index 417bfb5e..718aae9e 100644 --- a/docs/api/examples/post_projectsprojectidiouvmsvmidadaptersadapternumberdportsportnumberdstartcapture.txt +++ b/docs/api/examples/post_projectsprojectidiouvmsvmidadaptersadapternumberdportsportnumberdstartcapture.txt @@ -1,6 +1,6 @@ -curl -i -X POST 'http://localhost:8000/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/iou/vms/c40daea2-2b38-4d14-a872-13c5f991cbc3/adapters/0/ports/0/start_capture' -d '{"capture_file_name": "test.pcap", "data_link_type": "DLT_EN10MB"}' +curl -i -X POST 'http://localhost:8000/v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/iou/vms/a34cc9f3-e526-43c9-88ba-7379348d4a8d/adapters/0/ports/0/start_capture' -d '{"capture_file_name": "test.pcap", "data_link_type": "DLT_EN10MB"}' -POST /projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/iou/vms/c40daea2-2b38-4d14-a872-13c5f991cbc3/adapters/0/ports/0/start_capture HTTP/1.1 +POST /v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/iou/vms/a34cc9f3-e526-43c9-88ba-7379348d4a8d/adapters/0/ports/0/start_capture HTTP/1.1 { "capture_file_name": "test.pcap", "data_link_type": "DLT_EN10MB" @@ -12,9 +12,9 @@ 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 +SERVER: Python/3.4 GNS3/1.3.0.dev3 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/tmpn_q77wz2/a1e920ca-338a-4e9f-b363-aa607b09dd80/project-files/captures/test.pcap" + "pcap_file_path": "/var/folders/3s/r2wbv07n7wg4vrsn874lmxxh0000gn/T/tmp5qjzassw/a1e920ca-338a-4e9f-b363-aa607b09dd80/project-files/captures/test.pcap" } diff --git a/docs/api/examples/post_projectsprojectidiouvmsvmidadaptersadapternumberdportsportnumberdstopcapture.txt b/docs/api/examples/post_projectsprojectidiouvmsvmidadaptersadapternumberdportsportnumberdstopcapture.txt index c1987d70..1b3587b1 100644 --- a/docs/api/examples/post_projectsprojectidiouvmsvmidadaptersadapternumberdportsportnumberdstopcapture.txt +++ b/docs/api/examples/post_projectsprojectidiouvmsvmidadaptersadapternumberdportsportnumberdstopcapture.txt @@ -1,6 +1,6 @@ -curl -i -X POST 'http://localhost:8000/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/iou/vms/550b8f35-e258-4354-a74c-cd35a48c08ed/adapters/0/ports/0/stop_capture' -d '{}' +curl -i -X POST 'http://localhost:8000/v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/iou/vms/b097b2f1-8a72-4225-8a91-f5e9fe083de2/adapters/0/ports/0/stop_capture' -d '{}' -POST /projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/iou/vms/550b8f35-e258-4354-a74c-cd35a48c08ed/adapters/0/ports/0/stop_capture HTTP/1.1 +POST /v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/iou/vms/b097b2f1-8a72-4225-8a91-f5e9fe083de2/adapters/0/ports/0/stop_capture HTTP/1.1 {} @@ -8,6 +8,6 @@ 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 +SERVER: Python/3.4 GNS3/1.3.0.dev3 X-ROUTE: /v1/projects/{project_id}/iou/vms/{vm_id}/adapters/{adapter_number:\d+}/ports/{port_number:\d+}/stop_capture diff --git a/docs/api/examples/post_projectsprojectidiouvmsvmidreload.txt b/docs/api/examples/post_projectsprojectidiouvmsvmidreload.txt index 05ab639e..dff148a1 100644 --- a/docs/api/examples/post_projectsprojectidiouvmsvmidreload.txt +++ b/docs/api/examples/post_projectsprojectidiouvmsvmidreload.txt @@ -1,6 +1,6 @@ -curl -i -X POST 'http://localhost:8000/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/iou/vms/d1b38099-46a3-4405-a354-85faeb76bd0e/reload' -d '{}' +curl -i -X POST 'http://localhost:8000/v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/iou/vms/35de3d95-3f1b-4d99-94e4-f8262bbd9621/reload' -d '{}' -POST /projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/iou/vms/d1b38099-46a3-4405-a354-85faeb76bd0e/reload HTTP/1.1 +POST /v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/iou/vms/35de3d95-3f1b-4d99-94e4-f8262bbd9621/reload HTTP/1.1 {} @@ -8,6 +8,6 @@ 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 +SERVER: Python/3.4 GNS3/1.3.0.dev3 X-ROUTE: /v1/projects/{project_id}/iou/vms/{vm_id}/reload diff --git a/docs/api/examples/post_projectsprojectidiouvmsvmidstart.txt b/docs/api/examples/post_projectsprojectidiouvmsvmidstart.txt index d10d8c5d..aca9bfe4 100644 --- a/docs/api/examples/post_projectsprojectidiouvmsvmidstart.txt +++ b/docs/api/examples/post_projectsprojectidiouvmsvmidstart.txt @@ -1,6 +1,6 @@ -curl -i -X POST 'http://localhost:8000/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/iou/vms/fc1ea907-eb0b-4857-9ad2-759f780afdb4/start' -d '{}' +curl -i -X POST 'http://localhost:8000/v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/iou/vms/4f5e6326-7688-46c2-9dda-045a54a27a77/start' -d '{}' -POST /projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/iou/vms/fc1ea907-eb0b-4857-9ad2-759f780afdb4/start HTTP/1.1 +POST /v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/iou/vms/4f5e6326-7688-46c2-9dda-045a54a27a77/start HTTP/1.1 {} @@ -8,6 +8,6 @@ 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 +SERVER: Python/3.4 GNS3/1.3.0.dev3 X-ROUTE: /v1/projects/{project_id}/iou/vms/{vm_id}/start diff --git a/docs/api/examples/post_projectsprojectidiouvmsvmidstop.txt b/docs/api/examples/post_projectsprojectidiouvmsvmidstop.txt index d97a0400..57654494 100644 --- a/docs/api/examples/post_projectsprojectidiouvmsvmidstop.txt +++ b/docs/api/examples/post_projectsprojectidiouvmsvmidstop.txt @@ -1,6 +1,6 @@ -curl -i -X POST 'http://localhost:8000/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/iou/vms/0228866f-a286-44e2-9688-a8cab4e75cc3/stop' -d '{}' +curl -i -X POST 'http://localhost:8000/v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/iou/vms/6705e6b5-527d-41c9-b3ba-6d4711d820d1/stop' -d '{}' -POST /projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/iou/vms/0228866f-a286-44e2-9688-a8cab4e75cc3/stop HTTP/1.1 +POST /v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/iou/vms/6705e6b5-527d-41c9-b3ba-6d4711d820d1/stop HTTP/1.1 {} @@ -8,6 +8,6 @@ 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 +SERVER: Python/3.4 GNS3/1.3.0.dev3 X-ROUTE: /v1/projects/{project_id}/iou/vms/{vm_id}/stop diff --git a/docs/api/examples/post_projectsprojectidportsudp.txt b/docs/api/examples/post_projectsprojectidportsudp.txt new file mode 100644 index 00000000..6a683154 --- /dev/null +++ b/docs/api/examples/post_projectsprojectidportsudp.txt @@ -0,0 +1,17 @@ +curl -i -X POST 'http://localhost:8000/v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/ports/udp' -d '{}' + +POST /v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/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.0.dev3 +X-ROUTE: /v1/projects/{project_id}/ports/udp + +{ + "udp_port": 10000 +} diff --git a/docs/api/examples/post_projectsprojectidqemuvms.txt b/docs/api/examples/post_projectsprojectidqemuvms.txt index b0b4dc89..46448da8 100644 --- a/docs/api/examples/post_projectsprojectidqemuvms.txt +++ b/docs/api/examples/post_projectsprojectidqemuvms.txt @@ -1,20 +1,20 @@ -curl -i -X POST 'http://localhost:8000/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/qemu/vms' -d '{"hda_disk_image": "hda", "name": "PC TEST 1", "qemu_path": "/var/folders/3s/r2wbv07n7wg4vrsn874lmxxh0000gn/T/tmph25p8xei/qemu_x42", "ram": 1024}' +curl -i -X POST 'http://localhost:8000/v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/qemu/vms' -d '{"hda_disk_image": "/tmp/hda", "name": "PC TEST 1", "qemu_path": "/var/folders/3s/r2wbv07n7wg4vrsn874lmxxh0000gn/T/tmpyllkr06h/qemu_x42", "ram": 1024}' -POST /projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/qemu/vms HTTP/1.1 +POST /v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/qemu/vms HTTP/1.1 { - "hda_disk_image": "hda", + "hda_disk_image": "/tmp/hda", "name": "PC TEST 1", - "qemu_path": "/var/folders/3s/r2wbv07n7wg4vrsn874lmxxh0000gn/T/tmph25p8xei/qemu_x42", + "qemu_path": "/var/folders/3s/r2wbv07n7wg4vrsn874lmxxh0000gn/T/tmpyllkr06h/qemu_x42", "ram": 1024 } HTTP/1.1 201 CONNECTION: keep-alive -CONTENT-LENGTH: 570 +CONTENT-LENGTH: 606 CONTENT-TYPE: application/json DATE: Thu, 08 Jan 2015 16:09:15 GMT -SERVER: Python/3.4 GNS3/1.3.dev1 +SERVER: Python/3.4 GNS3/1.3.0.dev3 X-ROUTE: /v1/projects/{project_id}/qemu/vms { @@ -22,18 +22,19 @@ X-ROUTE: /v1/projects/{project_id}/qemu/vms "adapters": 1, "console": 2000, "cpu_throttling": 0, - "hda_disk_image": "hda", + "hda_disk_image": "/tmp/hda", "hdb_disk_image": "", + "hdc_disk_image": "", + "hdd_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/tmph25p8xei/qemu_x42", + "qemu_path": "/var/folders/3s/r2wbv07n7wg4vrsn874lmxxh0000gn/T/tmpyllkr06h/qemu_x42", "ram": 1024, - "vm_id": "4e47d2c8-d591-4508-9c3e-00e366f7c22d" + "vm_id": "3cf1c602-0b39-409c-8a96-b1f199d73c5f" } diff --git a/docs/api/examples/post_projectsprojectidqemuvmsvmidadaptersadapternumberdportsportnumberdnio.txt b/docs/api/examples/post_projectsprojectidqemuvmsvmidadaptersadapternumberdportsportnumberdnio.txt index a12017e1..ac91a7c7 100644 --- a/docs/api/examples/post_projectsprojectidqemuvmsvmidadaptersadapternumberdportsportnumberdnio.txt +++ b/docs/api/examples/post_projectsprojectidqemuvmsvmidadaptersadapternumberdportsportnumberdnio.txt @@ -1,6 +1,6 @@ -curl -i -X POST 'http://localhost:8000/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/qemu/vms/e4ac8960-f709-4e28-bc6c-3b2593b622e9/adapters/1/ports/0/nio' -d '{"ethernet_device": "eth0", "type": "nio_generic_ethernet"}' +curl -i -X POST 'http://localhost:8000/v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/qemu/vms/73ee0a6c-5c3d-435f-bf24-7a27b9c1f63c/adapters/1/ports/0/nio' -d '{"ethernet_device": "eth0", "type": "nio_generic_ethernet"}' -POST /projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/qemu/vms/e4ac8960-f709-4e28-bc6c-3b2593b622e9/adapters/1/ports/0/nio HTTP/1.1 +POST /v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/qemu/vms/73ee0a6c-5c3d-435f-bf24-7a27b9c1f63c/adapters/1/ports/0/nio HTTP/1.1 { "ethernet_device": "eth0", "type": "nio_generic_ethernet" @@ -12,7 +12,7 @@ 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 +SERVER: Python/3.4 GNS3/1.3.0.dev3 X-ROUTE: /v1/projects/{project_id}/qemu/vms/{vm_id}/adapters/{adapter_number:\d+}/ports/{port_number:\d+}/nio { diff --git a/docs/api/examples/post_projectsprojectidqemuvmsvmidreload.txt b/docs/api/examples/post_projectsprojectidqemuvmsvmidreload.txt index 0082474e..001e6476 100644 --- a/docs/api/examples/post_projectsprojectidqemuvmsvmidreload.txt +++ b/docs/api/examples/post_projectsprojectidqemuvmsvmidreload.txt @@ -1,6 +1,6 @@ -curl -i -X POST 'http://localhost:8000/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/qemu/vms/2a143130-2445-4a4b-9ba2-f49071eed5f4/reload' -d '{}' +curl -i -X POST 'http://localhost:8000/v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/qemu/vms/5d37a3e2-c9e8-4bf5-a4f7-5019b9d4720d/reload' -d '{}' -POST /projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/qemu/vms/2a143130-2445-4a4b-9ba2-f49071eed5f4/reload HTTP/1.1 +POST /v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/qemu/vms/5d37a3e2-c9e8-4bf5-a4f7-5019b9d4720d/reload HTTP/1.1 {} @@ -8,6 +8,6 @@ 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 +SERVER: Python/3.4 GNS3/1.3.0.dev3 X-ROUTE: /v1/projects/{project_id}/qemu/vms/{vm_id}/reload diff --git a/docs/api/examples/post_projectsprojectidqemuvmsvmidresume.txt b/docs/api/examples/post_projectsprojectidqemuvmsvmidresume.txt index 7a30d607..b3f543e7 100644 --- a/docs/api/examples/post_projectsprojectidqemuvmsvmidresume.txt +++ b/docs/api/examples/post_projectsprojectidqemuvmsvmidresume.txt @@ -1,6 +1,6 @@ -curl -i -X POST 'http://localhost:8000/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/qemu/vms/9272bffc-7a73-449a-aa71-96c48b1e5a3d/resume' -d '{}' +curl -i -X POST 'http://localhost:8000/v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/qemu/vms/804293f2-b3e8-4038-b38f-17292c09460e/resume' -d '{}' -POST /projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/qemu/vms/9272bffc-7a73-449a-aa71-96c48b1e5a3d/resume HTTP/1.1 +POST /v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/qemu/vms/804293f2-b3e8-4038-b38f-17292c09460e/resume HTTP/1.1 {} @@ -8,6 +8,6 @@ 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 +SERVER: Python/3.4 GNS3/1.3.0.dev3 X-ROUTE: /v1/projects/{project_id}/qemu/vms/{vm_id}/resume diff --git a/docs/api/examples/post_projectsprojectidqemuvmsvmidstart.txt b/docs/api/examples/post_projectsprojectidqemuvmsvmidstart.txt index 9071b899..dc165154 100644 --- a/docs/api/examples/post_projectsprojectidqemuvmsvmidstart.txt +++ b/docs/api/examples/post_projectsprojectidqemuvmsvmidstart.txt @@ -1,6 +1,6 @@ -curl -i -X POST 'http://localhost:8000/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/qemu/vms/e4f04682-d749-49c8-be3e-8c4752483cc1/start' -d '{}' +curl -i -X POST 'http://localhost:8000/v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/qemu/vms/65e1959a-2eec-4fb6-b664-36e408dd30be/start' -d '{}' -POST /projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/qemu/vms/e4f04682-d749-49c8-be3e-8c4752483cc1/start HTTP/1.1 +POST /v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/qemu/vms/65e1959a-2eec-4fb6-b664-36e408dd30be/start HTTP/1.1 {} @@ -8,6 +8,6 @@ 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 +SERVER: Python/3.4 GNS3/1.3.0.dev3 X-ROUTE: /v1/projects/{project_id}/qemu/vms/{vm_id}/start diff --git a/docs/api/examples/post_projectsprojectidqemuvmsvmidstop.txt b/docs/api/examples/post_projectsprojectidqemuvmsvmidstop.txt index a94f31e4..6513d5b9 100644 --- a/docs/api/examples/post_projectsprojectidqemuvmsvmidstop.txt +++ b/docs/api/examples/post_projectsprojectidqemuvmsvmidstop.txt @@ -1,6 +1,6 @@ -curl -i -X POST 'http://localhost:8000/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/qemu/vms/1cb28121-2b13-4c53-a0fc-ab8c6d028d0f/stop' -d '{}' +curl -i -X POST 'http://localhost:8000/v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/qemu/vms/54ac6a17-9f77-4c8a-b67a-a7bb33df6d79/stop' -d '{}' -POST /projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/qemu/vms/1cb28121-2b13-4c53-a0fc-ab8c6d028d0f/stop HTTP/1.1 +POST /v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/qemu/vms/54ac6a17-9f77-4c8a-b67a-a7bb33df6d79/stop HTTP/1.1 {} @@ -8,6 +8,6 @@ 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 +SERVER: Python/3.4 GNS3/1.3.0.dev3 X-ROUTE: /v1/projects/{project_id}/qemu/vms/{vm_id}/stop diff --git a/docs/api/examples/post_projectsprojectidqemuvmsvmidsuspend.txt b/docs/api/examples/post_projectsprojectidqemuvmsvmidsuspend.txt index ba5dd175..f2fbdea1 100644 --- a/docs/api/examples/post_projectsprojectidqemuvmsvmidsuspend.txt +++ b/docs/api/examples/post_projectsprojectidqemuvmsvmidsuspend.txt @@ -1,6 +1,6 @@ -curl -i -X POST 'http://localhost:8000/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/qemu/vms/777077ba-025a-49dc-9773-cedc425bdb6d/suspend' -d '{}' +curl -i -X POST 'http://localhost:8000/v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/qemu/vms/7d099201-de88-4a5c-bcb5-e16819ae4064/suspend' -d '{}' -POST /projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/qemu/vms/777077ba-025a-49dc-9773-cedc425bdb6d/suspend HTTP/1.1 +POST /v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/qemu/vms/7d099201-de88-4a5c-bcb5-e16819ae4064/suspend HTTP/1.1 {} @@ -8,6 +8,6 @@ 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 +SERVER: Python/3.4 GNS3/1.3.0.dev3 X-ROUTE: /v1/projects/{project_id}/qemu/vms/{vm_id}/suspend diff --git a/docs/api/examples/post_projectsprojectidvirtualboxvms.txt b/docs/api/examples/post_projectsprojectidvirtualboxvms.txt index c770d6ff..35132b80 100644 --- a/docs/api/examples/post_projectsprojectidvirtualboxvms.txt +++ b/docs/api/examples/post_projectsprojectidvirtualboxvms.txt @@ -1,6 +1,6 @@ -curl -i -X POST 'http://localhost:8000/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/virtualbox/vms' -d '{"linked_clone": false, "name": "VM1", "vmname": "VM1"}' +curl -i -X POST 'http://localhost:8000/v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/virtualbox/vms' -d '{"linked_clone": false, "name": "VM1", "vmname": "VM1"}' -POST /projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/virtualbox/vms HTTP/1.1 +POST /v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/virtualbox/vms HTTP/1.1 { "linked_clone": false, "name": "VM1", @@ -10,10 +10,10 @@ POST /projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/virtualbox/vms HTTP/1.1 HTTP/1.1 201 CONNECTION: keep-alive -CONTENT-LENGTH: 341 +CONTENT-LENGTH: 355 CONTENT-TYPE: application/json DATE: Thu, 08 Jan 2015 16:09:15 GMT -SERVER: Python/3.4 GNS3/1.3.dev1 +SERVER: Python/3.4 GNS3/1.3.0.dev3 X-ROUTE: /v1/projects/{project_id}/virtualbox/vms { @@ -24,7 +24,8 @@ X-ROUTE: /v1/projects/{project_id}/virtualbox/vms "headless": false, "name": "VM1", "project_id": "a1e920ca-338a-4e9f-b363-aa607b09dd80", + "ram": 0, "use_any_adapter": false, - "vm_id": "1404a6c5-c0f5-4bc6-bb94-477d7e631781", + "vm_id": "a829a5d1-6f0b-4240-a88c-35333dcbfd23", "vmname": "VM1" } diff --git a/docs/api/examples/post_projectsprojectidvirtualboxvmsvmidadaptersadapternumberdportsportnumberdnio.txt b/docs/api/examples/post_projectsprojectidvirtualboxvmsvmidadaptersadapternumberdportsportnumberdnio.txt index 1d5dbc65..3459ff0b 100644 --- a/docs/api/examples/post_projectsprojectidvirtualboxvmsvmidadaptersadapternumberdportsportnumberdnio.txt +++ b/docs/api/examples/post_projectsprojectidvirtualboxvmsvmidadaptersadapternumberdportsportnumberdnio.txt @@ -1,6 +1,6 @@ -curl -i -X POST 'http://localhost:8000/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/virtualbox/vms/bd0d175c-2055-4315-86d1-07494696d42e/adapters/0/ports/0/nio' -d '{"lport": 4242, "rhost": "127.0.0.1", "rport": 4343, "type": "nio_udp"}' +curl -i -X POST 'http://localhost:8000/v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/virtualbox/vms/6d747813-e7f8-410a-840e-1a58af07222b/adapters/0/ports/0/nio' -d '{"lport": 4242, "rhost": "127.0.0.1", "rport": 4343, "type": "nio_udp"}' -POST /projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/virtualbox/vms/bd0d175c-2055-4315-86d1-07494696d42e/adapters/0/ports/0/nio HTTP/1.1 +POST /v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/virtualbox/vms/6d747813-e7f8-410a-840e-1a58af07222b/adapters/0/ports/0/nio HTTP/1.1 { "lport": 4242, "rhost": "127.0.0.1", @@ -14,7 +14,7 @@ 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 +SERVER: Python/3.4 GNS3/1.3.0.dev3 X-ROUTE: /v1/projects/{project_id}/virtualbox/vms/{vm_id}/adapters/{adapter_number:\d+}/ports/{port_number:\d+}/nio { diff --git a/docs/api/examples/post_projectsprojectidvirtualboxvmsvmidreload.txt b/docs/api/examples/post_projectsprojectidvirtualboxvmsvmidreload.txt index df9a754b..14a1a25a 100644 --- a/docs/api/examples/post_projectsprojectidvirtualboxvmsvmidreload.txt +++ b/docs/api/examples/post_projectsprojectidvirtualboxvmsvmidreload.txt @@ -1,6 +1,6 @@ -curl -i -X POST 'http://localhost:8000/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/virtualbox/vms/4c9fdef4-8990-44a1-8a98-1b7c510821ee/reload' -d '{}' +curl -i -X POST 'http://localhost:8000/v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/virtualbox/vms/583d3d88-3e3b-4f14-a727-2350e7265fd2/reload' -d '{}' -POST /projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/virtualbox/vms/4c9fdef4-8990-44a1-8a98-1b7c510821ee/reload HTTP/1.1 +POST /v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/virtualbox/vms/583d3d88-3e3b-4f14-a727-2350e7265fd2/reload HTTP/1.1 {} @@ -8,6 +8,6 @@ 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 +SERVER: Python/3.4 GNS3/1.3.0.dev3 X-ROUTE: /v1/projects/{project_id}/virtualbox/vms/{vm_id}/reload diff --git a/docs/api/examples/post_projectsprojectidvirtualboxvmsvmidresume.txt b/docs/api/examples/post_projectsprojectidvirtualboxvmsvmidresume.txt index 40cb8a63..f8c1f272 100644 --- a/docs/api/examples/post_projectsprojectidvirtualboxvmsvmidresume.txt +++ b/docs/api/examples/post_projectsprojectidvirtualboxvmsvmidresume.txt @@ -1,6 +1,6 @@ -curl -i -X POST 'http://localhost:8000/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/virtualbox/vms/f6487814-a3a9-4e82-867c-83662c7bed48/resume' -d '{}' +curl -i -X POST 'http://localhost:8000/v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/virtualbox/vms/97ca91ab-3a0c-4026-bea9-8b48d0698b30/resume' -d '{}' -POST /projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/virtualbox/vms/f6487814-a3a9-4e82-867c-83662c7bed48/resume HTTP/1.1 +POST /v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/virtualbox/vms/97ca91ab-3a0c-4026-bea9-8b48d0698b30/resume HTTP/1.1 {} @@ -8,6 +8,6 @@ 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 +SERVER: Python/3.4 GNS3/1.3.0.dev3 X-ROUTE: /v1/projects/{project_id}/virtualbox/vms/{vm_id}/resume diff --git a/docs/api/examples/post_projectsprojectidvirtualboxvmsvmidstart.txt b/docs/api/examples/post_projectsprojectidvirtualboxvmsvmidstart.txt index 77ab559b..cc3d7636 100644 --- a/docs/api/examples/post_projectsprojectidvirtualboxvmsvmidstart.txt +++ b/docs/api/examples/post_projectsprojectidvirtualboxvmsvmidstart.txt @@ -1,6 +1,6 @@ -curl -i -X POST 'http://localhost:8000/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/virtualbox/vms/bedd61d4-b264-47d9-b290-920d5ba70f6d/start' -d '{}' +curl -i -X POST 'http://localhost:8000/v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/virtualbox/vms/5bb4c622-9978-4b7d-992a-f622fa8bef15/start' -d '{}' -POST /projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/virtualbox/vms/bedd61d4-b264-47d9-b290-920d5ba70f6d/start HTTP/1.1 +POST /v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/virtualbox/vms/5bb4c622-9978-4b7d-992a-f622fa8bef15/start HTTP/1.1 {} @@ -8,6 +8,6 @@ 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 +SERVER: Python/3.4 GNS3/1.3.0.dev3 X-ROUTE: /v1/projects/{project_id}/virtualbox/vms/{vm_id}/start diff --git a/docs/api/examples/post_projectsprojectidvirtualboxvmsvmidstop.txt b/docs/api/examples/post_projectsprojectidvirtualboxvmsvmidstop.txt index fb421804..da460924 100644 --- a/docs/api/examples/post_projectsprojectidvirtualboxvmsvmidstop.txt +++ b/docs/api/examples/post_projectsprojectidvirtualboxvmsvmidstop.txt @@ -1,6 +1,6 @@ -curl -i -X POST 'http://localhost:8000/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/virtualbox/vms/a1960146-9be9-4f54-b594-67a6ab40f436/stop' -d '{}' +curl -i -X POST 'http://localhost:8000/v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/virtualbox/vms/53efdb7e-d611-4455-9a24-b280ede45d45/stop' -d '{}' -POST /projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/virtualbox/vms/a1960146-9be9-4f54-b594-67a6ab40f436/stop HTTP/1.1 +POST /v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/virtualbox/vms/53efdb7e-d611-4455-9a24-b280ede45d45/stop HTTP/1.1 {} @@ -8,6 +8,6 @@ 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 +SERVER: Python/3.4 GNS3/1.3.0.dev3 X-ROUTE: /v1/projects/{project_id}/virtualbox/vms/{vm_id}/stop diff --git a/docs/api/examples/post_projectsprojectidvirtualboxvmsvmidsuspend.txt b/docs/api/examples/post_projectsprojectidvirtualboxvmsvmidsuspend.txt index 8b89fcd4..a15e6d1c 100644 --- a/docs/api/examples/post_projectsprojectidvirtualboxvmsvmidsuspend.txt +++ b/docs/api/examples/post_projectsprojectidvirtualboxvmsvmidsuspend.txt @@ -1,6 +1,6 @@ -curl -i -X POST 'http://localhost:8000/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/virtualbox/vms/4d16597f-fa75-430a-9b94-faf7f93bb0a3/suspend' -d '{}' +curl -i -X POST 'http://localhost:8000/v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/virtualbox/vms/ddb57c04-bce0-4989-ae42-5bc74340fc3e/suspend' -d '{}' -POST /projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/virtualbox/vms/4d16597f-fa75-430a-9b94-faf7f93bb0a3/suspend HTTP/1.1 +POST /v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/virtualbox/vms/ddb57c04-bce0-4989-ae42-5bc74340fc3e/suspend HTTP/1.1 {} @@ -8,6 +8,6 @@ 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 +SERVER: Python/3.4 GNS3/1.3.0.dev3 X-ROUTE: /v1/projects/{project_id}/virtualbox/vms/{vm_id}/suspend diff --git a/docs/api/examples/post_projectsprojectidvpcsvms.txt b/docs/api/examples/post_projectsprojectidvpcsvms.txt index f01fddfa..36a5b2a8 100644 --- a/docs/api/examples/post_projectsprojectidvpcsvms.txt +++ b/docs/api/examples/post_projectsprojectidvpcsvms.txt @@ -1,6 +1,6 @@ -curl -i -X POST 'http://localhost:8000/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/vpcs/vms' -d '{"name": "PC TEST 1"}' +curl -i -X POST 'http://localhost:8000/v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/vpcs/vms' -d '{"name": "PC TEST 1"}' -POST /projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/vpcs/vms HTTP/1.1 +POST /v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/vpcs/vms HTTP/1.1 { "name": "PC TEST 1" } @@ -11,7 +11,7 @@ CONNECTION: keep-alive CONTENT-LENGTH: 220 CONTENT-TYPE: application/json DATE: Thu, 08 Jan 2015 16:09:15 GMT -SERVER: Python/3.4 GNS3/1.3.dev1 +SERVER: Python/3.4 GNS3/1.3.0.dev3 X-ROUTE: /v1/projects/{project_id}/vpcs/vms { @@ -20,5 +20,5 @@ X-ROUTE: /v1/projects/{project_id}/vpcs/vms "project_id": "a1e920ca-338a-4e9f-b363-aa607b09dd80", "startup_script": null, "startup_script_path": null, - "vm_id": "b0d1df2e-ebd1-4783-bb62-871e24f01543" + "vm_id": "112a5edd-c104-41e2-aa6d-2bf980f835eb" } diff --git a/docs/api/examples/post_projectsprojectidvpcsvmsvmidadaptersadapternumberdportsportnumberdnio.txt b/docs/api/examples/post_projectsprojectidvpcsvmsvmidadaptersadapternumberdportsportnumberdnio.txt index 4ba387e6..bd2dd191 100644 --- a/docs/api/examples/post_projectsprojectidvpcsvmsvmidadaptersadapternumberdportsportnumberdnio.txt +++ b/docs/api/examples/post_projectsprojectidvpcsvmsvmidadaptersadapternumberdportsportnumberdnio.txt @@ -1,6 +1,6 @@ -curl -i -X POST 'http://localhost:8000/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/vpcs/vms/385d80e1-193c-4b38-bf55-5185ffd6b473/adapters/0/ports/0/nio' -d '{"lport": 4242, "rhost": "127.0.0.1", "rport": 4343, "type": "nio_udp"}' +curl -i -X POST 'http://localhost:8000/v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/vpcs/vms/c7155122-4e74-470b-835f-6be5834472b3/adapters/0/ports/0/nio' -d '{"lport": 4242, "rhost": "127.0.0.1", "rport": 4343, "type": "nio_udp"}' -POST /projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/vpcs/vms/385d80e1-193c-4b38-bf55-5185ffd6b473/adapters/0/ports/0/nio HTTP/1.1 +POST /v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/vpcs/vms/c7155122-4e74-470b-835f-6be5834472b3/adapters/0/ports/0/nio HTTP/1.1 { "lport": 4242, "rhost": "127.0.0.1", @@ -14,7 +14,7 @@ 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 +SERVER: Python/3.4 GNS3/1.3.0.dev3 X-ROUTE: /v1/projects/{project_id}/vpcs/vms/{vm_id}/adapters/{adapter_number:\d+}/ports/{port_number:\d+}/nio { diff --git a/docs/api/examples/post_projectsprojectidvpcsvmsvmidreload.txt b/docs/api/examples/post_projectsprojectidvpcsvmsvmidreload.txt index 5658f3cd..906a2ef7 100644 --- a/docs/api/examples/post_projectsprojectidvpcsvmsvmidreload.txt +++ b/docs/api/examples/post_projectsprojectidvpcsvmsvmidreload.txt @@ -1,6 +1,6 @@ -curl -i -X POST 'http://localhost:8000/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/vpcs/vms/b12c5612-147d-4229-86ca-103174ba8fd1/reload' -d '{}' +curl -i -X POST 'http://localhost:8000/v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/vpcs/vms/3408802b-3656-4a18-8679-cbdc503efcf9/reload' -d '{}' -POST /projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/vpcs/vms/b12c5612-147d-4229-86ca-103174ba8fd1/reload HTTP/1.1 +POST /v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/vpcs/vms/3408802b-3656-4a18-8679-cbdc503efcf9/reload HTTP/1.1 {} @@ -8,6 +8,6 @@ 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 +SERVER: Python/3.4 GNS3/1.3.0.dev3 X-ROUTE: /v1/projects/{project_id}/vpcs/vms/{vm_id}/reload diff --git a/docs/api/examples/post_projectsprojectidvpcsvmsvmidstart.txt b/docs/api/examples/post_projectsprojectidvpcsvmsvmidstart.txt index 4b903863..309e5d88 100644 --- a/docs/api/examples/post_projectsprojectidvpcsvmsvmidstart.txt +++ b/docs/api/examples/post_projectsprojectidvpcsvmsvmidstart.txt @@ -1,6 +1,6 @@ -curl -i -X POST 'http://localhost:8000/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/vpcs/vms/01037fd2-9533-42db-bd19-df5b21e47fcf/start' -d '{}' +curl -i -X POST 'http://localhost:8000/v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/vpcs/vms/cdf8626c-3455-49e5-a13a-5949acff1db8/start' -d '{}' -POST /projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/vpcs/vms/01037fd2-9533-42db-bd19-df5b21e47fcf/start HTTP/1.1 +POST /v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/vpcs/vms/cdf8626c-3455-49e5-a13a-5949acff1db8/start HTTP/1.1 {} @@ -8,6 +8,6 @@ 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 +SERVER: Python/3.4 GNS3/1.3.0.dev3 X-ROUTE: /v1/projects/{project_id}/vpcs/vms/{vm_id}/start diff --git a/docs/api/examples/post_projectsprojectidvpcsvmsvmidstop.txt b/docs/api/examples/post_projectsprojectidvpcsvmsvmidstop.txt index 01898946..09fb2ecf 100644 --- a/docs/api/examples/post_projectsprojectidvpcsvmsvmidstop.txt +++ b/docs/api/examples/post_projectsprojectidvpcsvmsvmidstop.txt @@ -1,6 +1,6 @@ -curl -i -X POST 'http://localhost:8000/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/vpcs/vms/20eefc85-f1b6-4e36-9601-cd0dc91faaa0/stop' -d '{}' +curl -i -X POST 'http://localhost:8000/v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/vpcs/vms/3cb294d9-b144-4b4d-a3be-fc27358551e7/stop' -d '{}' -POST /projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/vpcs/vms/20eefc85-f1b6-4e36-9601-cd0dc91faaa0/stop HTTP/1.1 +POST /v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/vpcs/vms/3cb294d9-b144-4b4d-a3be-fc27358551e7/stop HTTP/1.1 {} @@ -8,6 +8,6 @@ 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 +SERVER: Python/3.4 GNS3/1.3.0.dev3 X-ROUTE: /v1/projects/{project_id}/vpcs/vms/{vm_id}/stop diff --git a/docs/api/examples/post_version.txt b/docs/api/examples/post_version.txt index 2f6c1452..cc1ee781 100644 --- a/docs/api/examples/post_version.txt +++ b/docs/api/examples/post_version.txt @@ -1,19 +1,19 @@ -curl -i -X POST 'http://localhost:8000/version' -d '{"version": "1.3.dev1"}' +curl -i -X POST 'http://localhost:8000/v1/version' -d '{"version": "1.3.0.dev3"}' -POST /version HTTP/1.1 +POST /v1/version HTTP/1.1 { - "version": "1.3.dev1" + "version": "1.3.0.dev3" } HTTP/1.1 200 CONNECTION: keep-alive -CONTENT-LENGTH: 29 +CONTENT-LENGTH: 31 CONTENT-TYPE: application/json DATE: Thu, 08 Jan 2015 16:09:15 GMT -SERVER: Python/3.4 GNS3/1.3.dev1 +SERVER: Python/3.4 GNS3/1.3.0.dev3 X-ROUTE: /v1/version { - "version": "1.3.dev1" + "version": "1.3.0.dev3" } diff --git a/docs/api/examples/put_projectsprojectid.txt b/docs/api/examples/put_projectsprojectid.txt index 0e276071..6ba8cfbf 100644 --- a/docs/api/examples/put_projectsprojectid.txt +++ b/docs/api/examples/put_projectsprojectid.txt @@ -1,8 +1,9 @@ -curl -i -X PUT 'http://localhost:8000/projects/ef58b29e-59df-42c0-9492-5a766a13cb62' -d '{"path": "/private/var/folders/3s/r2wbv07n7wg4vrsn874lmxxh0000gn/T/pytest-3783/test_update_path_project_non_l0"}' +curl -i -X PUT 'http://localhost:8000/v1/projects/73d9e519-309f-4208-b885-07806199bf5f' -d '{"name": "second_name", "path": "/private/var/folders/3s/r2wbv07n7wg4vrsn874lmxxh0000gn/T/pytest-4332/test_update_path_project_non_l0"}' -PUT /projects/ef58b29e-59df-42c0-9492-5a766a13cb62 HTTP/1.1 +PUT /v1/projects/73d9e519-309f-4208-b885-07806199bf5f HTTP/1.1 { - "path": "/private/var/folders/3s/r2wbv07n7wg4vrsn874lmxxh0000gn/T/pytest-3783/test_update_path_project_non_l0" + "name": "second_name", + "path": "/private/var/folders/3s/r2wbv07n7wg4vrsn874lmxxh0000gn/T/pytest-4332/test_update_path_project_non_l0" } @@ -11,7 +12,7 @@ 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 +SERVER: Python/3.4 GNS3/1.3.0.dev3 X-ROUTE: /v1/projects/{project_id} { diff --git a/docs/api/examples/put_projectsprojectidiouvmsvmid.txt b/docs/api/examples/put_projectsprojectidiouvmsvmid.txt index 810284c6..c54a198b 100644 --- a/docs/api/examples/put_projectsprojectidiouvmsvmid.txt +++ b/docs/api/examples/put_projectsprojectidiouvmsvmid.txt @@ -1,36 +1,40 @@ -curl -i -X PUT 'http://localhost:8000/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/iou/vms/324dab07-d86c-4a3b-8390-7a8e9a506006' -d '{"console": 2001, "ethernet_adapters": 4, "initial_config_content": "hostname test", "l1_keepalives": true, "name": "test", "nvram": 2048, "ram": 512, "serial_adapters": 0}' +curl -i -X PUT 'http://localhost:8000/v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/iou/vms/4b9d6f16-84d4-43ff-8632-a11f5f3e208b' -d '{"console": 2001, "ethernet_adapters": 4, "initial_config_content": "hostname test", "iourc_content": "test", "l1_keepalives": true, "name": "test", "nvram": 2048, "ram": 512, "serial_adapters": 0, "use_default_iou_values": true}' -PUT /projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/iou/vms/324dab07-d86c-4a3b-8390-7a8e9a506006 HTTP/1.1 +PUT /v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/iou/vms/4b9d6f16-84d4-43ff-8632-a11f5f3e208b HTTP/1.1 { "console": 2001, "ethernet_adapters": 4, "initial_config_content": "hostname test", + "iourc_content": "test", "l1_keepalives": true, "name": "test", "nvram": 2048, "ram": 512, - "serial_adapters": 0 + "serial_adapters": 0, + "use_default_iou_values": true } HTTP/1.1 200 CONNECTION: keep-alive -CONTENT-LENGTH: 423 +CONTENT-LENGTH: 461 CONTENT-TYPE: application/json DATE: Thu, 08 Jan 2015 16:09:15 GMT -SERVER: Python/3.4 GNS3/1.3.dev1 +SERVER: Python/3.4 GNS3/1.3.0.dev3 X-ROUTE: /v1/projects/{project_id}/iou/vms/{vm_id} { "console": 2001, "ethernet_adapters": 4, "initial_config": "initial-config.cfg", + "iourc_path": "/var/folders/3s/r2wbv07n7wg4vrsn874lmxxh0000gn/T/tmpfj6kglsa/iourc", "l1_keepalives": true, "name": "test", "nvram": 2048, - "path": "/private/var/folders/3s/r2wbv07n7wg4vrsn874lmxxh0000gn/T/pytest-3783/test_iou_update0/iou.bin", + "path": "iou.bin", "project_id": "a1e920ca-338a-4e9f-b363-aa607b09dd80", "ram": 512, "serial_adapters": 0, - "vm_id": "324dab07-d86c-4a3b-8390-7a8e9a506006" + "use_default_iou_values": true, + "vm_id": "4b9d6f16-84d4-43ff-8632-a11f5f3e208b" } diff --git a/docs/api/examples/put_projectsprojectidqemuvmsvmid.txt b/docs/api/examples/put_projectsprojectidqemuvmsvmid.txt index 292fd2b1..0c20a28e 100644 --- a/docs/api/examples/put_projectsprojectidqemuvmsvmid.txt +++ b/docs/api/examples/put_projectsprojectidqemuvmsvmid.txt @@ -1,9 +1,9 @@ -curl -i -X PUT 'http://localhost:8000/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/qemu/vms/a68a00de-a264-4cc0-821c-301af5059ea4' -d '{"console": 2002, "hdb_disk_image": "hdb", "name": "test", "ram": 1024}' +curl -i -X PUT 'http://localhost:8000/v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/qemu/vms/824ca299-8319-47d8-a8f5-22d400dbe41a' -d '{"console": 2001, "hdb_disk_image": "/tmp/hdb", "name": "test", "ram": 1024}' -PUT /projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/qemu/vms/a68a00de-a264-4cc0-821c-301af5059ea4 HTTP/1.1 +PUT /v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/qemu/vms/824ca299-8319-47d8-a8f5-22d400dbe41a HTTP/1.1 { - "console": 2002, - "hdb_disk_image": "hdb", + "console": 2001, + "hdb_disk_image": "/tmp/hdb", "name": "test", "ram": 1024 } @@ -11,29 +11,30 @@ PUT /projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/qemu/vms/a68a00de-a264-4cc0-8 HTTP/1.1 200 CONNECTION: keep-alive -CONTENT-LENGTH: 565 +CONTENT-LENGTH: 601 CONTENT-TYPE: application/json DATE: Thu, 08 Jan 2015 16:09:15 GMT -SERVER: Python/3.4 GNS3/1.3.dev1 +SERVER: Python/3.4 GNS3/1.3.0.dev3 X-ROUTE: /v1/projects/{project_id}/qemu/vms/{vm_id} { "adapter_type": "e1000", "adapters": 1, - "console": 2002, + "console": 2001, "cpu_throttling": 0, "hda_disk_image": "", - "hdb_disk_image": "hdb", + "hdb_disk_image": "/tmp/hdb", + "hdc_disk_image": "", + "hdd_disk_image": "", "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/tmph25p8xei/qemu_x42", + "qemu_path": "/var/folders/3s/r2wbv07n7wg4vrsn874lmxxh0000gn/T/tmpyllkr06h/qemu_x42", "ram": 1024, - "vm_id": "a68a00de-a264-4cc0-821c-301af5059ea4" + "vm_id": "824ca299-8319-47d8-a8f5-22d400dbe41a" } diff --git a/docs/api/examples/put_projectsprojectidvirtualboxvmsvmid.txt b/docs/api/examples/put_projectsprojectidvirtualboxvmsvmid.txt index 480c4cf1..7fb62f8e 100644 --- a/docs/api/examples/put_projectsprojectidvirtualboxvmsvmid.txt +++ b/docs/api/examples/put_projectsprojectidvirtualboxvmsvmid.txt @@ -1,6 +1,6 @@ -curl -i -X PUT 'http://localhost:8000/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/virtualbox/vms/4a6375b9-14b8-406c-ae8e-df6d242088f9' -d '{"console": 2010, "name": "test"}' +curl -i -X PUT 'http://localhost:8000/v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/virtualbox/vms/e562f4e9-9951-446d-8f86-7fc2772cea87' -d '{"console": 2010, "name": "test"}' -PUT /projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/virtualbox/vms/4a6375b9-14b8-406c-ae8e-df6d242088f9 HTTP/1.1 +PUT /v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/virtualbox/vms/e562f4e9-9951-446d-8f86-7fc2772cea87 HTTP/1.1 { "console": 2010, "name": "test" @@ -9,10 +9,10 @@ PUT /projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/virtualbox/vms/4a6375b9-14b8- HTTP/1.1 200 CONNECTION: keep-alive -CONTENT-LENGTH: 345 +CONTENT-LENGTH: 359 CONTENT-TYPE: application/json DATE: Thu, 08 Jan 2015 16:09:15 GMT -SERVER: Python/3.4 GNS3/1.3.dev1 +SERVER: Python/3.4 GNS3/1.3.0.dev3 X-ROUTE: /v1/projects/{project_id}/virtualbox/vms/{vm_id} { @@ -23,7 +23,8 @@ X-ROUTE: /v1/projects/{project_id}/virtualbox/vms/{vm_id} "headless": false, "name": "test", "project_id": "a1e920ca-338a-4e9f-b363-aa607b09dd80", + "ram": 0, "use_any_adapter": false, - "vm_id": "4a6375b9-14b8-406c-ae8e-df6d242088f9", + "vm_id": "e562f4e9-9951-446d-8f86-7fc2772cea87", "vmname": "VMTEST" } diff --git a/docs/api/examples/put_projectsprojectidvpcsvmsvmid.txt b/docs/api/examples/put_projectsprojectidvpcsvmsvmid.txt index b90c37ca..c97fd82a 100644 --- a/docs/api/examples/put_projectsprojectidvpcsvmsvmid.txt +++ b/docs/api/examples/put_projectsprojectidvpcsvmsvmid.txt @@ -1,6 +1,6 @@ -curl -i -X PUT 'http://localhost:8000/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/vpcs/vms/39951883-cbfb-4aff-9cbc-06895749e571' -d '{"console": 2011, "name": "test", "startup_script": "ip 192.168.1.1"}' +curl -i -X PUT 'http://localhost:8000/v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/vpcs/vms/043ec361-ba80-48a5-b332-ee76050a25b6' -d '{"console": 2011, "name": "test", "startup_script": "ip 192.168.1.1"}' -PUT /projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/vpcs/vms/39951883-cbfb-4aff-9cbc-06895749e571 HTTP/1.1 +PUT /v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/vpcs/vms/043ec361-ba80-48a5-b332-ee76050a25b6 HTTP/1.1 { "console": 2011, "name": "test", @@ -13,7 +13,7 @@ CONNECTION: keep-alive CONTENT-LENGTH: 236 CONTENT-TYPE: application/json DATE: Thu, 08 Jan 2015 16:09:15 GMT -SERVER: Python/3.4 GNS3/1.3.dev1 +SERVER: Python/3.4 GNS3/1.3.0.dev3 X-ROUTE: /v1/projects/{project_id}/vpcs/vms/{vm_id} { @@ -22,5 +22,5 @@ X-ROUTE: /v1/projects/{project_id}/vpcs/vms/{vm_id} "project_id": "a1e920ca-338a-4e9f-b363-aa607b09dd80", "startup_script": "ip 192.168.1.1", "startup_script_path": "startup.vpc", - "vm_id": "39951883-cbfb-4aff-9cbc-06895749e571" + "vm_id": "043ec361-ba80-48a5-b332-ee76050a25b6" } diff --git a/docs/api/v1/config.rst b/docs/api/v1/config.rst new file mode 100644 index 00000000..7d03319f --- /dev/null +++ b/docs/api/v1/config.rst @@ -0,0 +1,8 @@ +Config +--------------------- + +.. toctree:: + :glob: + :maxdepth: 2 + + config/* diff --git a/docs/api/v1/network/portsudp.rst b/docs/api/v1/config/configreload.rst similarity index 64% rename from docs/api/v1/network/portsudp.rst rename to docs/api/v1/config/configreload.rst index c37318ed..02b0265f 100644 --- a/docs/api/v1/network/portsudp.rst +++ b/docs/api/v1/config/configreload.rst @@ -1,19 +1,20 @@ -/v1/ports/udp +/v1/config/reload ---------------------------------------------------------------------------------------------------------------------- .. contents:: -POST /v1/ports/udp +POST /v1/config/reload ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -Allocate an UDP port on the server +Check if version is the same as the server Response status codes ********************** -- **201**: UDP port allocated +- **201**: Config reload +- **403**: Config reload refused Sample session *************** -.. literalinclude:: ../../examples/post_portsudp.txt +.. literalinclude:: ../../examples/post_configreload.txt diff --git a/docs/api/v1/dynamips_device/projectsprojectiddynamipsdevices.rst b/docs/api/v1/dynamips_device/projectsprojectiddynamipsdevices.rst index d43ed5bf..acbe839e 100644 --- a/docs/api/v1/dynamips_device/projectsprojectiddynamipsdevices.rst +++ b/docs/api/v1/dynamips_device/projectsprojectiddynamipsdevices.rst @@ -23,7 +23,7 @@ Input - +
Name Mandatory Type Description
device_id string Dynamips device instance identifier
device_id Dynamips device instance identifier
device_type ✔ string Dynamips device type
name ✔ string Dynamips device name
diff --git a/docs/api/v1/dynamips_device/projectsprojectiddynamipsdevicesdeviceid.rst b/docs/api/v1/dynamips_device/projectsprojectiddynamipsdevicesdeviceid.rst index 7f0e65e4..1ff726ba 100644 --- a/docs/api/v1/dynamips_device/projectsprojectiddynamipsdevicesdeviceid.rst +++ b/docs/api/v1/dynamips_device/projectsprojectiddynamipsdevicesdeviceid.rst @@ -9,8 +9,8 @@ Get a Dynamips device instance Parameters ********** -- **project_id**: UUID for the project - **device_id**: UUID for the instance +- **project_id**: UUID for the project Response status codes ********************** @@ -38,8 +38,8 @@ Update a Dynamips device instance Parameters ********** -- **project_id**: UUID for the project - **device_id**: UUID for the instance +- **project_id**: UUID for the project Response status codes ********************** @@ -95,8 +95,8 @@ Delete a Dynamips device instance Parameters ********** -- **project_id**: UUID for the project - **device_id**: UUID for the instance +- **project_id**: UUID for the project Response status codes ********************** diff --git a/docs/api/v1/dynamips_device/projectsprojectiddynamipsdevicesdeviceidportsportnumberdnio.rst b/docs/api/v1/dynamips_device/projectsprojectiddynamipsdevicesdeviceidportsportnumberdnio.rst index 706b5c06..bb237012 100644 --- a/docs/api/v1/dynamips_device/projectsprojectiddynamipsdevicesdeviceidportsportnumberdnio.rst +++ b/docs/api/v1/dynamips_device/projectsprojectiddynamipsdevicesdeviceidportsportnumberdnio.rst @@ -9,9 +9,9 @@ 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 +- **project_id**: UUID for the project Response status codes ********************** @@ -128,9 +128,9 @@ 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 +- **project_id**: UUID for the project Response status codes ********************** diff --git a/docs/api/v1/dynamips_device/projectsprojectiddynamipsdevicesdeviceidportsportnumberdstartcapture.rst b/docs/api/v1/dynamips_device/projectsprojectiddynamipsdevicesdeviceidportsportnumberdstartcapture.rst index 19852f49..41cc168f 100644 --- a/docs/api/v1/dynamips_device/projectsprojectiddynamipsdevicesdeviceidportsportnumberdstartcapture.rst +++ b/docs/api/v1/dynamips_device/projectsprojectiddynamipsdevicesdeviceidportsportnumberdstartcapture.rst @@ -9,9 +9,9 @@ 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 +- **project_id**: UUID for the project Response status codes ********************** diff --git a/docs/api/v1/dynamips_device/projectsprojectiddynamipsdevicesdeviceidportsportnumberdstopcapture.rst b/docs/api/v1/dynamips_device/projectsprojectiddynamipsdevicesdeviceidportsportnumberdstopcapture.rst index cc312e43..9318bdd1 100644 --- a/docs/api/v1/dynamips_device/projectsprojectiddynamipsdevicesdeviceidportsportnumberdstopcapture.rst +++ b/docs/api/v1/dynamips_device/projectsprojectiddynamipsdevicesdeviceidportsportnumberdstopcapture.rst @@ -9,9 +9,9 @@ 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 +- **project_id**: UUID for the project Response status codes ********************** diff --git a/docs/api/v1/dynamips_vm/projectsprojectiddynamipsvms.rst b/docs/api/v1/dynamips_vm/projectsprojectiddynamipsvms.rst index b50dfdad..a8b15b28 100644 --- a/docs/api/v1/dynamips_vm/projectsprojectiddynamipsvms.rst +++ b/docs/api/v1/dynamips_vm/projectsprojectiddynamipsvms.rst @@ -26,7 +26,6 @@ Input aux integer auxiliary console TCP port chassis string router chassis model clock_divisor integer clock divisor - confreg string configuration register console integer console TCP port disk0 integer disk0 size in MB disk1 integer disk1 size in MB @@ -74,10 +73,9 @@ Output - + - diff --git a/docs/api/v1/dynamips_vm/projectsprojectiddynamipsvmsvmid.rst b/docs/api/v1/dynamips_vm/projectsprojectiddynamipsvmsvmid.rst index 11b3c065..20216ed5 100644 --- a/docs/api/v1/dynamips_vm/projectsprojectiddynamipsvmsvmid.rst +++ b/docs/api/v1/dynamips_vm/projectsprojectiddynamipsvmsvmid.rst @@ -9,8 +9,8 @@ Get a Dynamips VM instance Parameters ********** -- **project_id**: UUID for the project - **vm_id**: UUID for the instance +- **project_id**: UUID for the project Response status codes ********************** @@ -24,10 +24,9 @@ Output
Name Mandatory Type Description
aux integer auxiliary console TCP port
aux ['integer', 'null'] auxiliary console TCP port
chassis string router chassis model
clock_divisor integer clock divisor
confreg string configuration register
console integer console TCP port
disk0 integer disk0 size in MB
disk1 integer disk1 size in MB
- + - @@ -75,8 +74,8 @@ Update a Dynamips VM instance Parameters ********** -- **project_id**: UUID for the project - **vm_id**: UUID for the instance +- **project_id**: UUID for the project Response status codes ********************** @@ -94,7 +93,6 @@ Input - @@ -140,10 +138,9 @@ Output
Name Mandatory Type Description
aux integer auxiliary console TCP port
aux ['integer', 'null'] auxiliary console TCP port
chassis string router chassis model
clock_divisor integer clock divisor
confreg string configuration register
console integer console TCP port
disk0 integer disk0 size in MB
disk1 integer disk1 size in MB
aux integer auxiliary console TCP port
chassis string router chassis model
clock_divisor integer clock divisor
confreg string configuration register
console integer console TCP port
disk0 integer disk0 size in MB
disk1 integer disk1 size in MB
- + - @@ -191,8 +188,8 @@ Delete a Dynamips VM instance Parameters ********** -- **project_id**: UUID for the project - **vm_id**: UUID for the instance +- **project_id**: UUID for the project Response status codes ********************** diff --git a/docs/api/v1/dynamips_vm/projectsprojectiddynamipsvmsvmidadaptersadapternumberdportsportnumberdnio.rst b/docs/api/v1/dynamips_vm/projectsprojectiddynamipsvmsvmidadaptersadapternumberdportsportnumberdnio.rst index 25d0a246..5b8656ee 100644 --- a/docs/api/v1/dynamips_vm/projectsprojectiddynamipsvmsvmidadaptersadapternumberdportsportnumberdnio.rst +++ b/docs/api/v1/dynamips_vm/projectsprojectiddynamipsvmsvmidadaptersadapternumberdportsportnumberdnio.rst @@ -9,10 +9,10 @@ Add a NIO to a Dynamips VM instance Parameters ********** -- **project_id**: UUID for the project -- **vm_id**: UUID for the instance - **adapter_number**: Adapter where the nio should be added - **port_number**: Port on the adapter +- **vm_id**: UUID for the instance +- **project_id**: UUID for the project Response status codes ********************** @@ -27,10 +27,10 @@ Remove a NIO from a Dynamips VM instance Parameters ********** -- **project_id**: UUID for the project -- **vm_id**: UUID for the instance - **adapter_number**: Adapter from where the nio should be removed - **port_number**: Port on the adapter +- **vm_id**: UUID for the instance +- **project_id**: UUID for the project Response status codes ********************** diff --git a/docs/api/v1/dynamips_vm/projectsprojectiddynamipsvmsvmidadaptersadapternumberdportsportnumberdstartcapture.rst b/docs/api/v1/dynamips_vm/projectsprojectiddynamipsvmsvmidadaptersadapternumberdportsportnumberdstartcapture.rst index 0d54a8c6..0c0ee7ae 100644 --- a/docs/api/v1/dynamips_vm/projectsprojectiddynamipsvmsvmidadaptersadapternumberdportsportnumberdstartcapture.rst +++ b/docs/api/v1/dynamips_vm/projectsprojectiddynamipsvmsvmidadaptersadapternumberdportsportnumberdstartcapture.rst @@ -9,10 +9,10 @@ Start a packet capture on a Dynamips VM instance Parameters ********** -- **project_id**: UUID for the project -- **vm_id**: UUID for the instance - **adapter_number**: Adapter to start a packet capture - **port_number**: Port on the adapter +- **vm_id**: UUID for the instance +- **project_id**: UUID for the project Response status codes ********************** diff --git a/docs/api/v1/dynamips_vm/projectsprojectiddynamipsvmsvmidadaptersadapternumberdportsportnumberdstopcapture.rst b/docs/api/v1/dynamips_vm/projectsprojectiddynamipsvmsvmidadaptersadapternumberdportsportnumberdstopcapture.rst index f89a083c..af649484 100644 --- a/docs/api/v1/dynamips_vm/projectsprojectiddynamipsvmsvmidadaptersadapternumberdportsportnumberdstopcapture.rst +++ b/docs/api/v1/dynamips_vm/projectsprojectiddynamipsvmsvmidadaptersadapternumberdportsportnumberdstopcapture.rst @@ -9,10 +9,10 @@ Stop a packet capture on a Dynamips VM instance Parameters ********** -- **project_id**: UUID for the project -- **vm_id**: UUID for the instance - **adapter_number**: Adapter to stop a packet capture - **port_number**: Port on the adapter (always 0) +- **vm_id**: UUID for the instance +- **project_id**: UUID for the project Response status codes ********************** diff --git a/docs/api/v1/dynamips_vm/projectsprojectiddynamipsvmsvmidconfigssave.rst b/docs/api/v1/dynamips_vm/projectsprojectiddynamipsvmsvmidconfigssave.rst new file mode 100644 index 00000000..064aad43 --- /dev/null +++ b/docs/api/v1/dynamips_vm/projectsprojectiddynamipsvmsvmidconfigssave.rst @@ -0,0 +1,15 @@ +/v1/projects/{project_id}/dynamips/vms/{vm_id}/configs/save +---------------------------------------------------------------------------------------------------------------------- + +.. contents:: + +POST /v1/projects/**{project_id}**/dynamips/vms/**{vm_id}**/configs/save +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +Save the startup and private configs content + +Response status codes +********************** +- **200**: Configs saved +- **400**: Invalid request +- **404**: Instance doesn't exist + diff --git a/docs/api/v1/dynamips_vm/projectsprojectiddynamipsvmsvmidreload.rst b/docs/api/v1/dynamips_vm/projectsprojectiddynamipsvmsvmidreload.rst index 23bb67f3..d7d7df55 100644 --- a/docs/api/v1/dynamips_vm/projectsprojectiddynamipsvmsvmidreload.rst +++ b/docs/api/v1/dynamips_vm/projectsprojectiddynamipsvmsvmidreload.rst @@ -9,8 +9,8 @@ Reload a Dynamips VM instance Parameters ********** -- **project_id**: UUID for the project - **vm_id**: UUID for the instance +- **project_id**: UUID for the project Response status codes ********************** diff --git a/docs/api/v1/dynamips_vm/projectsprojectiddynamipsvmsvmidresume.rst b/docs/api/v1/dynamips_vm/projectsprojectiddynamipsvmsvmidresume.rst index 73ce9d01..fcd48ab5 100644 --- a/docs/api/v1/dynamips_vm/projectsprojectiddynamipsvmsvmidresume.rst +++ b/docs/api/v1/dynamips_vm/projectsprojectiddynamipsvmsvmidresume.rst @@ -9,8 +9,8 @@ Resume a suspended Dynamips VM instance Parameters ********** -- **project_id**: UUID for the project - **vm_id**: UUID for the instance +- **project_id**: UUID for the project Response status codes ********************** diff --git a/docs/api/v1/dynamips_vm/projectsprojectiddynamipsvmsvmidstart.rst b/docs/api/v1/dynamips_vm/projectsprojectiddynamipsvmsvmidstart.rst index 24c3d2af..2dbd25b8 100644 --- a/docs/api/v1/dynamips_vm/projectsprojectiddynamipsvmsvmidstart.rst +++ b/docs/api/v1/dynamips_vm/projectsprojectiddynamipsvmsvmidstart.rst @@ -9,8 +9,8 @@ Start a Dynamips VM instance Parameters ********** -- **project_id**: UUID for the project - **vm_id**: UUID for the instance +- **project_id**: UUID for the project Response status codes ********************** diff --git a/docs/api/v1/dynamips_vm/projectsprojectiddynamipsvmsvmidstop.rst b/docs/api/v1/dynamips_vm/projectsprojectiddynamipsvmsvmidstop.rst index fca471b6..ff62c2c9 100644 --- a/docs/api/v1/dynamips_vm/projectsprojectiddynamipsvmsvmidstop.rst +++ b/docs/api/v1/dynamips_vm/projectsprojectiddynamipsvmsvmidstop.rst @@ -9,8 +9,8 @@ Stop a Dynamips VM instance Parameters ********** -- **project_id**: UUID for the project - **vm_id**: UUID for the instance +- **project_id**: UUID for the project Response status codes ********************** diff --git a/docs/api/v1/dynamips_vm/projectsprojectiddynamipsvmsvmidsuspend.rst b/docs/api/v1/dynamips_vm/projectsprojectiddynamipsvmsvmidsuspend.rst index 54394e01..b6fb8a13 100644 --- a/docs/api/v1/dynamips_vm/projectsprojectiddynamipsvmsvmidsuspend.rst +++ b/docs/api/v1/dynamips_vm/projectsprojectiddynamipsvmsvmidsuspend.rst @@ -9,8 +9,8 @@ Suspend a Dynamips VM instance Parameters ********** -- **project_id**: UUID for the project - **vm_id**: UUID for the instance +- **project_id**: UUID for the project Response status codes ********************** diff --git a/docs/api/v1/network/projectsprojectidportsudp.rst b/docs/api/v1/network/projectsprojectidportsudp.rst new file mode 100644 index 00000000..046d863a --- /dev/null +++ b/docs/api/v1/network/projectsprojectidportsudp.rst @@ -0,0 +1,24 @@ +/v1/projects/{project_id}/ports/udp +---------------------------------------------------------------------------------------------------------------------- + +.. contents:: + +POST /v1/projects/**{project_id}**/ports/udp +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +Allocate an UDP port on the server + +Parameters +********** +- **project_id**: The UUID of the project + +Response status codes +********************** +- **201**: UDP port allocated +- **404**: The project doesn't exist + +Sample session +*************** + + +.. literalinclude:: ../../examples/post_projectsprojectidportsudp.txt + diff --git a/docs/api/v1/project/projects.rst b/docs/api/v1/project/projects.rst index 53f234b7..e9299195 100644 --- a/docs/api/v1/project/projects.rst +++ b/docs/api/v1/project/projects.rst @@ -18,6 +18,7 @@ Input
Name Mandatory Type Description
aux integer auxiliary console TCP port
aux ['integer', 'null'] auxiliary console TCP port
chassis string router chassis model
clock_divisor integer clock divisor
confreg string configuration register
console integer console TCP port
disk0 integer disk0 size in MB
disk1 integer disk1 size in MB
+ @@ -30,6 +31,7 @@ Output
Name Mandatory Type Description
name ['string', 'null'] Project name
path ['string', 'null'] Project directory
project_id ['string', 'null'] Project UUID
temporary boolean If project is a temporary project
+ diff --git a/docs/api/v1/project/projectsprojectid.rst b/docs/api/v1/project/projectsprojectid.rst index bed089de..0772e7d7 100644 --- a/docs/api/v1/project/projectsprojectid.rst +++ b/docs/api/v1/project/projectsprojectid.rst @@ -23,6 +23,7 @@ Output
Name Mandatory Type Description
location ✔ string Base directory where the project should be created on remote server
name string Project name
path string Directory of the project on the server
project_id ✔ string Project UUID
temporary ✔ boolean If project is a temporary project
+ @@ -55,6 +56,7 @@ Input
Name Mandatory Type Description
location ✔ string Base directory where the project should be created on remote server
name string Project name
path string Directory of the project on the server
project_id ✔ string Project UUID
temporary ✔ boolean If project is a temporary project
+
Name Mandatory Type Description
name ['string', 'null'] Project name
path ['string', 'null'] Path of the project on the server (work only with --local)
temporary boolean If project is a temporary project
@@ -66,6 +68,7 @@ Output + diff --git a/docs/api/v1/qemu/projectsprojectidqemuvms.rst b/docs/api/v1/qemu/projectsprojectidqemuvms.rst index 155fa581..6c3d8e65 100644 --- a/docs/api/v1/qemu/projectsprojectidqemuvms.rst +++ b/docs/api/v1/qemu/projectsprojectidqemuvms.rst @@ -29,17 +29,18 @@ Input + + - - +
Name Mandatory Type Description
location ✔ string Base directory where the project should be created on remote server
name string Project name
path string Directory of the project on the server
project_id ✔ string Project UUID
temporary ✔ boolean If project is a temporary project
cpu_throttling ['integer', 'null'] Percentage of CPU allowed for QEMU
hda_disk_image ['string', 'null'] QEMU hda disk image path
hdb_disk_image ['string', 'null'] QEMU hdb disk image path
hdc_disk_image ['string', 'null'] QEMU hdc disk image path
hdd_disk_image ['string', 'null'] QEMU hdd disk image path
initrd ['string', 'null'] QEMU initrd path
kernel_command_line ['string', 'null'] QEMU kernel command line
kernel_image ['string', 'null'] QEMU kernel image path
legacy_networking ['boolean', 'null'] Use QEMU legagy networking commands (-net syntax)
monitor ['integer', 'null'] monitor TCP port
name ✔ string QEMU VM instance name
options ['string', 'null'] Additional QEMU options
process_priority enum Possible values: realtime, very high, high, normal, low, very low, null
qemu_path ✔ string Path to QEMU
ram ['integer', 'null'] amount of RAM in MB
vm_id ['string', 'null'] QEMU VM UUID
vm_id QEMU VM identifier
Output @@ -54,11 +55,12 @@ Output cpu_throttling ✔ integer Percentage of CPU allowed for QEMU hda_disk_image ✔ string QEMU hda disk image path hdb_disk_image ✔ string QEMU hdb disk image path + hdc_disk_image ✔ string QEMU hdc disk image path + hdd_disk_image ✔ string QEMU hdd disk image path initrd ✔ string QEMU initrd path kernel_command_line ✔ string QEMU kernel command line kernel_image ✔ string QEMU kernel image path legacy_networking ✔ boolean Use QEMU legagy networking commands (-net syntax) - monitor ✔ integer monitor TCP port name ✔ string QEMU VM instance name options ✔ string Additional QEMU options process_priority ✔ enum Possible values: realtime, very high, high, normal, low, very low diff --git a/docs/api/v1/qemu/projectsprojectidqemuvmsvmid.rst b/docs/api/v1/qemu/projectsprojectidqemuvmsvmid.rst index 0270bbd9..494bfb7c 100644 --- a/docs/api/v1/qemu/projectsprojectidqemuvmsvmid.rst +++ b/docs/api/v1/qemu/projectsprojectidqemuvmsvmid.rst @@ -9,8 +9,8 @@ Get a Qemu.instance Parameters ********** -- **project_id**: UUID for the project - **vm_id**: UUID for the instance +- **project_id**: UUID for the project Response status codes ********************** @@ -30,11 +30,12 @@ Output cpu_throttling ✔ integer Percentage of CPU allowed for QEMU hda_disk_image ✔ string QEMU hda disk image path hdb_disk_image ✔ string QEMU hdb disk image path + hdc_disk_image ✔ string QEMU hdc disk image path + hdd_disk_image ✔ string QEMU hdd disk image path initrd ✔ string QEMU initrd path kernel_command_line ✔ string QEMU kernel command line kernel_image ✔ string QEMU kernel image path legacy_networking ✔ boolean Use QEMU legagy networking commands (-net syntax) - monitor ✔ integer monitor TCP port name ✔ string QEMU VM instance name options ✔ string Additional QEMU options process_priority ✔ enum Possible values: realtime, very high, high, normal, low, very low @@ -57,8 +58,8 @@ Update a Qemu.instance Parameters ********** -- **project_id**: UUID for the project - **vm_id**: UUID for the instance +- **project_id**: UUID for the project Response status codes ********************** @@ -79,11 +80,12 @@ Input cpu_throttling ['integer', 'null'] Percentage of CPU allowed for QEMU hda_disk_image ['string', 'null'] QEMU hda disk image path hdb_disk_image ['string', 'null'] QEMU hdb disk image path + hdc_disk_image ['string', 'null'] QEMU hdc disk image path + hdd_disk_image ['string', 'null'] QEMU hdd disk image path initrd ['string', 'null'] QEMU initrd path kernel_command_line ['string', 'null'] QEMU kernel command line kernel_image ['string', 'null'] QEMU kernel image path legacy_networking ['boolean', 'null'] Use QEMU legagy networking commands (-net syntax) - monitor ['integer', 'null'] monitor TCP port name ['string', 'null'] QEMU VM instance name options ['string', 'null'] Additional QEMU options process_priority enum Possible values: realtime, very high, high, normal, low, very low, null @@ -103,11 +105,12 @@ Output cpu_throttling ✔ integer Percentage of CPU allowed for QEMU hda_disk_image ✔ string QEMU hda disk image path hdb_disk_image ✔ string QEMU hdb disk image path + hdc_disk_image ✔ string QEMU hdc disk image path + hdd_disk_image ✔ string QEMU hdd disk image path initrd ✔ string QEMU initrd path kernel_command_line ✔ string QEMU kernel command line kernel_image ✔ string QEMU kernel image path legacy_networking ✔ boolean Use QEMU legagy networking commands (-net syntax) - monitor ✔ integer monitor TCP port name ✔ string QEMU VM instance name options ✔ string Additional QEMU options process_priority ✔ enum Possible values: realtime, very high, high, normal, low, very low @@ -130,8 +133,8 @@ Delete a Qemu.instance Parameters ********** -- **project_id**: UUID for the project - **vm_id**: UUID for the instance +- **project_id**: UUID for the project Response status codes ********************** diff --git a/docs/api/v1/qemu/projectsprojectidqemuvmsvmidadaptersadapternumberdportsportnumberdnio.rst b/docs/api/v1/qemu/projectsprojectidqemuvmsvmidadaptersadapternumberdportsportnumberdnio.rst index e1c94c53..4f18372b 100644 --- a/docs/api/v1/qemu/projectsprojectidqemuvmsvmidadaptersadapternumberdportsportnumberdnio.rst +++ b/docs/api/v1/qemu/projectsprojectidqemuvmsvmidadaptersadapternumberdportsportnumberdnio.rst @@ -9,10 +9,10 @@ Add a NIO to a Qemu.instance Parameters ********** -- **project_id**: UUID for the project -- **vm_id**: UUID for the instance - **adapter_number**: Network adapter where the nio is located -- **port_number**: Port where the nio should be added +- **port_number**: Port on the adapter (always 0) +- **vm_id**: UUID for the instance +- **project_id**: UUID for the project Response status codes ********************** @@ -33,10 +33,10 @@ Remove a NIO from a Qemu.instance Parameters ********** -- **project_id**: UUID for the project -- **vm_id**: UUID for the instance - **adapter_number**: Network adapter where the nio is located -- **port_number**: Port from where the nio should be removed +- **port_number**: Port on the adapter (always 0) +- **vm_id**: UUID for the instance +- **project_id**: UUID for the project Response status codes ********************** diff --git a/docs/api/v1/qemu/projectsprojectidqemuvmsvmidreload.rst b/docs/api/v1/qemu/projectsprojectidqemuvmsvmidreload.rst index 5b29cec3..a33af01f 100644 --- a/docs/api/v1/qemu/projectsprojectidqemuvmsvmidreload.rst +++ b/docs/api/v1/qemu/projectsprojectidqemuvmsvmidreload.rst @@ -9,8 +9,8 @@ Reload a Qemu.instance Parameters ********** -- **project_id**: UUID for the project - **vm_id**: UUID for the instance +- **project_id**: UUID for the project Response status codes ********************** diff --git a/docs/api/v1/qemu/projectsprojectidqemuvmsvmidresume.rst b/docs/api/v1/qemu/projectsprojectidqemuvmsvmidresume.rst index 59b5c1f7..c3d3b967 100644 --- a/docs/api/v1/qemu/projectsprojectidqemuvmsvmidresume.rst +++ b/docs/api/v1/qemu/projectsprojectidqemuvmsvmidresume.rst @@ -9,8 +9,8 @@ Resume a Qemu.instance Parameters ********** -- **project_id**: UUID for the project - **vm_id**: UUID for the instance +- **project_id**: UUID for the project Response status codes ********************** diff --git a/docs/api/v1/qemu/projectsprojectidqemuvmsvmidstart.rst b/docs/api/v1/qemu/projectsprojectidqemuvmsvmidstart.rst index f5306892..063832b1 100644 --- a/docs/api/v1/qemu/projectsprojectidqemuvmsvmidstart.rst +++ b/docs/api/v1/qemu/projectsprojectidqemuvmsvmidstart.rst @@ -9,8 +9,8 @@ Start a Qemu.instance Parameters ********** -- **project_id**: UUID for the project - **vm_id**: UUID for the instance +- **project_id**: UUID for the project Response status codes ********************** diff --git a/docs/api/v1/qemu/projectsprojectidqemuvmsvmidstop.rst b/docs/api/v1/qemu/projectsprojectidqemuvmsvmidstop.rst index d5c41c96..bb6af81f 100644 --- a/docs/api/v1/qemu/projectsprojectidqemuvmsvmidstop.rst +++ b/docs/api/v1/qemu/projectsprojectidqemuvmsvmidstop.rst @@ -9,8 +9,8 @@ Stop a Qemu.instance Parameters ********** -- **project_id**: UUID for the project - **vm_id**: UUID for the instance +- **project_id**: UUID for the project Response status codes ********************** diff --git a/docs/api/v1/qemu/projectsprojectidqemuvmsvmidsuspend.rst b/docs/api/v1/qemu/projectsprojectidqemuvmsvmidsuspend.rst index 63e8c94a..36f0e34d 100644 --- a/docs/api/v1/qemu/projectsprojectidqemuvmsvmidsuspend.rst +++ b/docs/api/v1/qemu/projectsprojectidqemuvmsvmidsuspend.rst @@ -9,8 +9,8 @@ Suspend a Qemu.instance Parameters ********** -- **project_id**: UUID for the project - **vm_id**: UUID for the instance +- **project_id**: UUID for the project Response status codes ********************** diff --git a/docs/api/v1/server.rst b/docs/api/v1/server.rst new file mode 100644 index 00000000..fcb176b4 --- /dev/null +++ b/docs/api/v1/server.rst @@ -0,0 +1,8 @@ +Server +--------------------- + +.. toctree:: + :glob: + :maxdepth: 2 + + server/* diff --git a/docs/api/v1/server/servershutdown.rst b/docs/api/v1/server/servershutdown.rst new file mode 100644 index 00000000..de662fd8 --- /dev/null +++ b/docs/api/v1/server/servershutdown.rst @@ -0,0 +1,14 @@ +/v1/server/shutdown +---------------------------------------------------------------------------------------------------------------------- + +.. contents:: + +POST /v1/server/shutdown +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +Shutdown the local server + +Response status codes +********************** +- **201**: Server is shutting down +- **403**: Server shutdown refused + diff --git a/docs/api/v1/version/version.rst b/docs/api/v1/version/version.rst index 8733379d..942bb705 100644 --- a/docs/api/v1/version/version.rst +++ b/docs/api/v1/version/version.rst @@ -17,6 +17,7 @@ Output +
Name Mandatory Type Description
local boolean Either this is a local server
version ✔ string Version number human readable
@@ -42,6 +43,7 @@ Input +
Name Mandatory Type Description
local boolean Either this is a local server
version ✔ string Version number human readable
@@ -51,6 +53,7 @@ Output +
Name Mandatory Type Description
local boolean Either this is a local server
version ✔ string Version number human readable
diff --git a/docs/api/v1/virtualbox/projectsprojectidvirtualboxvms.rst b/docs/api/v1/virtualbox/projectsprojectidvirtualboxvms.rst index 03d96831..a6a77682 100644 --- a/docs/api/v1/virtualbox/projectsprojectidvirtualboxvms.rst +++ b/docs/api/v1/virtualbox/projectsprojectidvirtualboxvms.rst @@ -30,6 +30,7 @@ Input headless boolean headless mode linked_clone ✔ boolean either the VM is a linked clone or not name ✔ string VirtualBox VM instance name + ram integer Amount of RAM use_any_adapter boolean allow GNS3 to use any VirtualBox adapter vm_id VirtualBox VM instance identifier vmname ✔ string VirtualBox VM name (in VirtualBox itself) @@ -48,6 +49,7 @@ Output headless boolean headless mode name ✔ string VirtualBox VM instance name project_id ✔ string Project UUID + ram integer Amount of RAM use_any_adapter boolean allow GNS3 to use any VirtualBox adapter vm_id ✔ string VirtualBox VM instance UUID vmname string VirtualBox VM name (in VirtualBox itself) diff --git a/docs/api/v1/virtualbox/projectsprojectidvirtualboxvmsvmid.rst b/docs/api/v1/virtualbox/projectsprojectidvirtualboxvmsvmid.rst index 8ec38157..d345c454 100644 --- a/docs/api/v1/virtualbox/projectsprojectidvirtualboxvmsvmid.rst +++ b/docs/api/v1/virtualbox/projectsprojectidvirtualboxvmsvmid.rst @@ -9,8 +9,8 @@ Get a VirtualBox VM instance Parameters ********** -- **project_id**: UUID for the project - **vm_id**: UUID for the instance +- **project_id**: UUID for the project Response status codes ********************** @@ -31,6 +31,7 @@ Output headless boolean headless mode name ✔ string VirtualBox VM instance name project_id ✔ string Project UUID + ram integer Amount of RAM use_any_adapter boolean allow GNS3 to use any VirtualBox adapter vm_id ✔ string VirtualBox VM instance UUID vmname string VirtualBox VM name (in VirtualBox itself) @@ -49,8 +50,8 @@ Update a VirtualBox VM instance Parameters ********** -- **project_id**: UUID for the project - **vm_id**: UUID for the instance +- **project_id**: UUID for the project Response status codes ********************** @@ -71,6 +72,7 @@ Input enable_remote_console boolean enable the remote console headless boolean headless mode name string VirtualBox VM instance name + ram integer Amount of RAM use_any_adapter boolean allow GNS3 to use any VirtualBox adapter vmname string VirtualBox VM name (in VirtualBox itself) @@ -88,6 +90,7 @@ Output headless boolean headless mode name ✔ string VirtualBox VM instance name project_id ✔ string Project UUID + ram integer Amount of RAM use_any_adapter boolean allow GNS3 to use any VirtualBox adapter vm_id ✔ string VirtualBox VM instance UUID vmname string VirtualBox VM name (in VirtualBox itself) @@ -106,8 +109,8 @@ Delete a VirtualBox VM instance Parameters ********** -- **project_id**: UUID for the project - **vm_id**: UUID for the instance +- **project_id**: UUID for the project Response status codes ********************** diff --git a/docs/api/v1/virtualbox/projectsprojectidvirtualboxvmsvmidadaptersadapternumberdportsportnumberdnio.rst b/docs/api/v1/virtualbox/projectsprojectidvirtualboxvmsvmidadaptersadapternumberdportsportnumberdnio.rst index 0ba49c65..521fc9e5 100644 --- a/docs/api/v1/virtualbox/projectsprojectidvirtualboxvmsvmidadaptersadapternumberdportsportnumberdnio.rst +++ b/docs/api/v1/virtualbox/projectsprojectidvirtualboxvmsvmidadaptersadapternumberdportsportnumberdnio.rst @@ -9,10 +9,10 @@ Add a NIO to a VirtualBox VM instance Parameters ********** -- **project_id**: UUID for the project -- **vm_id**: UUID for the instance - **adapter_number**: Adapter where the nio should be added - **port_number**: Port on the adapter (always 0) +- **vm_id**: UUID for the instance +- **project_id**: UUID for the project Response status codes ********************** @@ -33,10 +33,10 @@ Remove a NIO from a VirtualBox VM instance Parameters ********** -- **project_id**: UUID for the project -- **vm_id**: UUID for the instance - **adapter_number**: Adapter from where the nio should be removed -- **port_number**: Port on the adapter (always) +- **port_number**: Port on the adapter (always 0) +- **vm_id**: UUID for the instance +- **project_id**: UUID for the project Response status codes ********************** diff --git a/docs/api/v1/virtualbox/projectsprojectidvirtualboxvmsvmidadaptersadapternumberdportsportnumberdstartcapture.rst b/docs/api/v1/virtualbox/projectsprojectidvirtualboxvmsvmidadaptersadapternumberdportsportnumberdstartcapture.rst index 402ccc5e..7c2c18c5 100644 --- a/docs/api/v1/virtualbox/projectsprojectidvirtualboxvmsvmidadaptersadapternumberdportsportnumberdstartcapture.rst +++ b/docs/api/v1/virtualbox/projectsprojectidvirtualboxvmsvmidadaptersadapternumberdportsportnumberdstartcapture.rst @@ -9,10 +9,10 @@ Start a packet capture on a VirtualBox VM instance Parameters ********** -- **project_id**: UUID for the project -- **vm_id**: UUID for the instance - **adapter_number**: Adapter to start a packet capture - **port_number**: Port on the adapter (always 0) +- **vm_id**: UUID for the instance +- **project_id**: UUID for the project Response status codes ********************** diff --git a/docs/api/v1/virtualbox/projectsprojectidvirtualboxvmsvmidadaptersadapternumberdportsportnumberdstopcapture.rst b/docs/api/v1/virtualbox/projectsprojectidvirtualboxvmsvmidadaptersadapternumberdportsportnumberdstopcapture.rst index 63e1f22d..2fae09a2 100644 --- a/docs/api/v1/virtualbox/projectsprojectidvirtualboxvmsvmidadaptersadapternumberdportsportnumberdstopcapture.rst +++ b/docs/api/v1/virtualbox/projectsprojectidvirtualboxvmsvmidadaptersadapternumberdportsportnumberdstopcapture.rst @@ -9,10 +9,10 @@ Stop a packet capture on a VirtualBox VM instance Parameters ********** -- **project_id**: UUID for the project -- **vm_id**: UUID for the instance - **adapter_number**: Adapter to stop a packet capture - **port_number**: Port on the adapter (always 0) +- **vm_id**: UUID for the instance +- **project_id**: UUID for the project Response status codes ********************** diff --git a/docs/api/v1/virtualbox/projectsprojectidvirtualboxvmsvmidreload.rst b/docs/api/v1/virtualbox/projectsprojectidvirtualboxvmsvmidreload.rst index 9ae84c29..d3c83c0e 100644 --- a/docs/api/v1/virtualbox/projectsprojectidvirtualboxvmsvmidreload.rst +++ b/docs/api/v1/virtualbox/projectsprojectidvirtualboxvmsvmidreload.rst @@ -9,8 +9,8 @@ Reload a VirtualBox VM instance Parameters ********** -- **project_id**: UUID for the project - **vm_id**: UUID for the instance +- **project_id**: UUID for the project Response status codes ********************** diff --git a/docs/api/v1/virtualbox/projectsprojectidvirtualboxvmsvmidresume.rst b/docs/api/v1/virtualbox/projectsprojectidvirtualboxvmsvmidresume.rst index 0fb9d427..e05c62dc 100644 --- a/docs/api/v1/virtualbox/projectsprojectidvirtualboxvmsvmidresume.rst +++ b/docs/api/v1/virtualbox/projectsprojectidvirtualboxvmsvmidresume.rst @@ -9,8 +9,8 @@ Resume a suspended VirtualBox VM instance Parameters ********** -- **project_id**: UUID for the project - **vm_id**: UUID for the instance +- **project_id**: UUID for the project Response status codes ********************** diff --git a/docs/api/v1/virtualbox/projectsprojectidvirtualboxvmsvmidstart.rst b/docs/api/v1/virtualbox/projectsprojectidvirtualboxvmsvmidstart.rst index 5e6a6c42..5901fdbf 100644 --- a/docs/api/v1/virtualbox/projectsprojectidvirtualboxvmsvmidstart.rst +++ b/docs/api/v1/virtualbox/projectsprojectidvirtualboxvmsvmidstart.rst @@ -9,8 +9,8 @@ Start a VirtualBox VM instance Parameters ********** -- **project_id**: UUID for the project - **vm_id**: UUID for the instance +- **project_id**: UUID for the project Response status codes ********************** diff --git a/docs/api/v1/virtualbox/projectsprojectidvirtualboxvmsvmidstop.rst b/docs/api/v1/virtualbox/projectsprojectidvirtualboxvmsvmidstop.rst index 1eaac889..cc20ef18 100644 --- a/docs/api/v1/virtualbox/projectsprojectidvirtualboxvmsvmidstop.rst +++ b/docs/api/v1/virtualbox/projectsprojectidvirtualboxvmsvmidstop.rst @@ -9,8 +9,8 @@ Stop a VirtualBox VM instance Parameters ********** -- **project_id**: UUID for the project - **vm_id**: UUID for the instance +- **project_id**: UUID for the project Response status codes ********************** diff --git a/docs/api/v1/virtualbox/projectsprojectidvirtualboxvmsvmidsuspend.rst b/docs/api/v1/virtualbox/projectsprojectidvirtualboxvmsvmidsuspend.rst index ad7f469b..e957b666 100644 --- a/docs/api/v1/virtualbox/projectsprojectidvirtualboxvmsvmidsuspend.rst +++ b/docs/api/v1/virtualbox/projectsprojectidvirtualboxvmsvmidsuspend.rst @@ -9,8 +9,8 @@ Suspend a VirtualBox VM instance Parameters ********** -- **project_id**: UUID for the project - **vm_id**: UUID for the instance +- **project_id**: UUID for the project Response status codes ********************** diff --git a/docs/api/v1/vpcs/projectsprojectidvpcsvmsvmid.rst b/docs/api/v1/vpcs/projectsprojectidvpcsvmsvmid.rst index 08762d16..0ff49d0a 100644 --- a/docs/api/v1/vpcs/projectsprojectidvpcsvmsvmid.rst +++ b/docs/api/v1/vpcs/projectsprojectidvpcsvmsvmid.rst @@ -9,8 +9,8 @@ Get a VPCS instance Parameters ********** -- **project_id**: UUID for the project - **vm_id**: UUID for the instance +- **project_id**: UUID for the project Response status codes ********************** @@ -45,8 +45,8 @@ Update a VPCS instance Parameters ********** -- **project_id**: UUID for the project - **vm_id**: UUID for the instance +- **project_id**: UUID for the project Response status codes ********************** @@ -93,8 +93,8 @@ Delete a VPCS instance Parameters ********** -- **project_id**: UUID for the project - **vm_id**: UUID for the instance +- **project_id**: UUID for the project Response status codes ********************** diff --git a/docs/api/v1/vpcs/projectsprojectidvpcsvmsvmidadaptersadapternumberdportsportnumberdnio.rst b/docs/api/v1/vpcs/projectsprojectidvpcsvmsvmidadaptersadapternumberdportsportnumberdnio.rst index a10f3587..c275d357 100644 --- a/docs/api/v1/vpcs/projectsprojectidvpcsvmsvmidadaptersadapternumberdportsportnumberdnio.rst +++ b/docs/api/v1/vpcs/projectsprojectidvpcsvmsvmidadaptersadapternumberdportsportnumberdnio.rst @@ -9,10 +9,10 @@ Add a NIO to a VPCS instance Parameters ********** -- **project_id**: UUID for the project -- **vm_id**: UUID for the instance - **adapter_number**: Network adapter where the nio is located - **port_number**: Port where the nio should be added +- **vm_id**: UUID for the instance +- **project_id**: UUID for the project Response status codes ********************** @@ -33,10 +33,10 @@ Remove a NIO from a VPCS instance Parameters ********** -- **project_id**: UUID for the project -- **vm_id**: UUID for the instance - **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 +- **project_id**: UUID for the project Response status codes ********************** diff --git a/docs/api/v1/vpcs/projectsprojectidvpcsvmsvmidreload.rst b/docs/api/v1/vpcs/projectsprojectidvpcsvmsvmidreload.rst index 224798fd..0aa2eea1 100644 --- a/docs/api/v1/vpcs/projectsprojectidvpcsvmsvmidreload.rst +++ b/docs/api/v1/vpcs/projectsprojectidvpcsvmsvmidreload.rst @@ -9,8 +9,8 @@ Reload a VPCS instance Parameters ********** -- **project_id**: UUID for the project - **vm_id**: UUID for the instance +- **project_id**: UUID for the project Response status codes ********************** diff --git a/docs/api/v1/vpcs/projectsprojectidvpcsvmsvmidstart.rst b/docs/api/v1/vpcs/projectsprojectidvpcsvmsvmidstart.rst index b87f43a6..838a512b 100644 --- a/docs/api/v1/vpcs/projectsprojectidvpcsvmsvmidstart.rst +++ b/docs/api/v1/vpcs/projectsprojectidvpcsvmsvmidstart.rst @@ -9,8 +9,8 @@ Start a VPCS instance Parameters ********** -- **project_id**: UUID for the project - **vm_id**: UUID for the instance +- **project_id**: UUID for the project Response status codes ********************** diff --git a/docs/api/v1/vpcs/projectsprojectidvpcsvmsvmidstop.rst b/docs/api/v1/vpcs/projectsprojectidvpcsvmsvmidstop.rst index 269c8953..606cc8fb 100644 --- a/docs/api/v1/vpcs/projectsprojectidvpcsvmsvmidstop.rst +++ b/docs/api/v1/vpcs/projectsprojectidvpcsvmsvmidstop.rst @@ -9,8 +9,8 @@ Stop a VPCS instance Parameters ********** -- **project_id**: UUID for the project - **vm_id**: UUID for the instance +- **project_id**: UUID for the project Response status codes ********************** diff --git a/tests/handlers/api/base.py b/tests/handlers/api/base.py index fe13a45e..6a4fd02e 100644 --- a/tests/handlers/api/base.py +++ b/tests/handlers/api/base.py @@ -93,20 +93,20 @@ class Query: response.json = {} response.html = "" if kwargs.get('example') and os.environ.get("PYTEST_BUILD_DOCUMENTATION") == "1": - self._dump_example(method, response.route, path, body, response) + self._dump_example(method, response.route, api_version, path, body, response) return response - def _dump_example(self, method, route, path, body, response): + def _dump_example(self, method, route, api_version, path, body, response): """Dump the request for the documentation""" if path is None: return with open(self._example_file_path(method, route), 'w+') as f: - f.write("curl -i -X {} 'http://localhost:8000{}'".format(method, path)) + f.write("curl -i -X {} 'http://localhost:8000/v{}{}'".format(method, api_version, path)) if body: f.write(" -d '{}'".format(re.sub(r"\n", "", json.dumps(json.loads(body), sort_keys=True)))) f.write("\n\n") - f.write("{} {} HTTP/1.1\n".format(method, path)) + f.write("{} /v{}{} HTTP/1.1\n".format(method, api_version, path)) if body: f.write(json.dumps(json.loads(body), sort_keys=True, indent=4)) f.write("\n\n\n")