Fix doc generation

This commit is contained in:
Julien Duponchelle committed 2016-03-11 15:39:42 +01:00
1 parent a0ef68c1a3
commit 69bf8bbb4e
112 files changed
+251 -296

No files matched your search

@@ -1,8 +0,0 @@
Gns3server.handlers.index
-----------------------------
.. toctree::
:glob:
:maxdepth: 2
gns3server.handlers.index/*
@@ -1,13 +0,0 @@
/
------------------------------------------------------------------------------------------------------------------------------------------
.. contents::
GET /
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Home page for GNS3Server
Response status codes
**********************
- **200**: OK
@@ -1,13 +0,0 @@
/status
------------------------------------------------------------------------------------------------------------------------------------------
.. contents::
GET /status
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Ressources used by GNS3Server
Response status codes
**********************
- **200**: OK
@@ -1,13 +0,0 @@
/v1/version
------------------------------------------------------------------------------------------------------------------------------------------
.. contents::
GET /v1/version
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Old API
Response status codes
**********************
- **200**: OK
@@ -9,8 +9,8 @@ Update a Docker instance
Parameters
**********
- **project_id**: UUID for the project
- **vm_id**: UUID for the instance
- **project_id**: UUID for the project
Response status codes
**********************
@@ -9,10 +9,10 @@ Add a NIO to a Docker container
Parameters
**********
- **adapter_number**: Adapter where the nio should be added
- **port_number**: Port on the adapter
- **project_id**: UUID for the project
- **id**: ID of the container
- **port_number**: Port on the adapter
- **adapter_number**: Adapter where the nio should be added
Response status codes
**********************
@@ -33,10 +33,10 @@ Remove a NIO from a Docker container
Parameters
**********
- **adapter_number**: Adapter where the nio should be added
- **port_number**: Port on the adapter
- **project_id**: UUID for the project
- **id**: ID of the container
- **port_number**: Port on the adapter
- **adapter_number**: Adapter where the nio should be added
Response status codes
**********************
@@ -9,10 +9,10 @@ Start a packet capture on a IOU VM instance
Parameters
**********
- **project_id**: UUID for the project
- **adapter_number**: Adapter to start a packet capture
- **port_number**: Port on the adapter
- **vm_id**: UUID for the instance
- **adapter_number**: Adapter to start a packet capture
- **project_id**: UUID for the project
Response status codes
**********************
@@ -9,10 +9,10 @@ Stop a packet capture on a IOU VM instance
Parameters
**********
- **project_id**: UUID for the project
- **adapter_number**: Adapter to stop a packet capture
- **port_number**: Port on the adapter (always 0)
- **vm_id**: UUID for the instance
- **adapter_number**: Adapter to stop a packet capture
- **project_id**: UUID for the project
Response status codes
**********************
@@ -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
**********************
@@ -96,8 +96,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
**********************
@@ -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
**********************
@@ -139,9 +139,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
**********************
@@ -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
**********************
@@ -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
**********************
@@ -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
**********************
@@ -77,8 +77,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
**********************
@@ -194,8 +194,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
**********************
@@ -9,10 +9,10 @@ Add a NIO to a Dynamips VM instance
Parameters
**********
- **project_id**: UUID for the project
- **adapter_number**: Adapter where the nio should be added
- **port_number**: Port on the adapter
- **vm_id**: UUID for the instance
- **adapter_number**: Adapter where the nio should be added
- **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
- **adapter_number**: Adapter from where the nio should be removed
- **port_number**: Port on the adapter
- **vm_id**: UUID for the instance
- **adapter_number**: Adapter from where the nio should be removed
- **project_id**: UUID for the project
Response status codes
**********************
@@ -9,10 +9,10 @@ Start a packet capture on a Dynamips VM instance
Parameters
**********
- **project_id**: UUID for the project
- **adapter_number**: Adapter to start a packet capture
- **port_number**: Port on the adapter
- **vm_id**: UUID for the instance
- **adapter_number**: Adapter to start a packet capture
- **project_id**: UUID for the project
Response status codes
**********************
@@ -9,10 +9,10 @@ Stop a packet capture on a Dynamips VM instance
Parameters
**********
- **project_id**: UUID for the project
- **adapter_number**: Adapter to stop a packet capture
- **port_number**: Port on the adapter (always 0)
- **vm_id**: UUID for the instance
- **adapter_number**: Adapter to stop a packet capture
- **project_id**: UUID for the project
Response status codes
**********************
@@ -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
**********************
@@ -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
**********************
@@ -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
**********************
@@ -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
**********************
@@ -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
**********************
@@ -9,8 +9,8 @@ Get a IOU instance
Parameters
**********
- **project_id**: UUID for the project
- **vm_id**: UUID for the instance
- **project_id**: UUID for the project
Response status codes
**********************
@@ -56,8 +56,8 @@ Update a IOU instance
Parameters
**********
- **project_id**: UUID for the project
- **vm_id**: UUID for the instance
- **project_id**: UUID for the project
Response status codes
**********************
@@ -125,8 +125,8 @@ Delete a IOU instance
Parameters
**********
- **project_id**: UUID for the project
- **vm_id**: UUID for the instance
- **project_id**: UUID for the project
Response status codes
**********************
@@ -9,10 +9,10 @@ Add a NIO to a IOU instance
Parameters
**********
- **project_id**: UUID for the project
- **adapter_number**: Network adapter where the nio is located
- **port_number**: Port where the nio should be added
- **vm_id**: UUID for the instance
- **adapter_number**: Network adapter where the nio is located
- **project_id**: UUID for the project
Response status codes
**********************
@@ -33,10 +33,10 @@ Remove a NIO from a IOU instance
Parameters
**********
- **project_id**: UUID for the project
- **adapter_number**: Network adapter where the nio is located
- **port_number**: Port from where the nio should be removed
- **vm_id**: UUID for the instance
- **adapter_number**: Network adapter where the nio is located
- **project_id**: UUID for the project
Response status codes
**********************
@@ -9,10 +9,10 @@ Start a packet capture on a IOU VM instance
Parameters
**********
- **project_id**: UUID for the project
- **adapter_number**: Adapter to start a packet capture
- **port_number**: Port on the adapter
- **vm_id**: UUID for the instance
- **adapter_number**: Adapter to start a packet capture
- **project_id**: UUID for the project
Response status codes
**********************
@@ -9,10 +9,10 @@ Stop a packet capture on a IOU VM instance
Parameters
**********
- **project_id**: UUID for the project
- **adapter_number**: Adapter to stop a packet capture
- **port_number**: Port on the adapter (always 0)
- **vm_id**: UUID for the instance
- **adapter_number**: Adapter to stop a packet capture
- **project_id**: UUID for the project
Response status codes
**********************
@@ -9,8 +9,8 @@ Reload a IOU instance
Parameters
**********
- **project_id**: UUID for the project
- **vm_id**: UUID for the instance
- **project_id**: UUID for the project
Response status codes
**********************
@@ -9,8 +9,8 @@ Start a IOU instance
Parameters
**********
- **project_id**: UUID for the project
- **vm_id**: UUID for the instance
- **project_id**: UUID for the project
Response status codes
**********************
@@ -9,8 +9,8 @@ Stop a IOU instance
Parameters
**********
- **project_id**: UUID for the project
- **vm_id**: UUID for the instance
- **project_id**: UUID for the project
Response status codes
**********************
@@ -9,8 +9,8 @@ Get a Qemu VM instance
Parameters
**********
- **project_id**: UUID for the project
- **vm_id**: UUID for the instance
- **project_id**: UUID for the project
Response status codes
**********************
@@ -79,8 +79,8 @@ Update a Qemu VM instance
Parameters
**********
- **project_id**: UUID for the project
- **vm_id**: UUID for the instance
- **project_id**: UUID for the project
Response status codes
**********************
@@ -194,8 +194,8 @@ Delete a Qemu VM instance
Parameters
**********
- **project_id**: UUID for the project
- **vm_id**: UUID for the instance
- **project_id**: UUID for the project
Response status codes
**********************
@@ -9,10 +9,10 @@ Add a NIO to a Qemu VM instance
Parameters
**********
- **project_id**: UUID for the project
- **adapter_number**: Network adapter where the nio is located
- **port_number**: Port on the adapter (always 0)
- **vm_id**: UUID for the instance
- **adapter_number**: Network adapter where the nio is located
- **project_id**: UUID for the project
Response status codes
**********************
@@ -33,10 +33,10 @@ Remove a NIO from a Qemu VM instance
Parameters
**********
- **project_id**: UUID for the project
- **adapter_number**: Network adapter where the nio is located
- **port_number**: Port on the adapter (always 0)
- **vm_id**: UUID for the instance
- **adapter_number**: Network adapter where the nio is located
- **project_id**: UUID for the project
Response status codes
**********************
@@ -9,8 +9,8 @@ Reload a Qemu VM instance
Parameters
**********
- **project_id**: UUID for the project
- **vm_id**: UUID for the instance
- **project_id**: UUID for the project
Response status codes
**********************
@@ -9,8 +9,8 @@ Resume a Qemu VM instance
Parameters
**********
- **project_id**: UUID for the project
- **vm_id**: UUID for the instance
- **project_id**: UUID for the project
Response status codes
**********************
@@ -9,8 +9,8 @@ Start a Qemu VM instance
Parameters
**********
- **project_id**: UUID for the project
- **vm_id**: UUID for the instance
- **project_id**: UUID for the project
Response status codes
**********************
@@ -9,8 +9,8 @@ Stop a Qemu VM instance
Parameters
**********
- **project_id**: UUID for the project
- **vm_id**: UUID for the instance
- **project_id**: UUID for the project
Response status codes
**********************
@@ -9,8 +9,8 @@ Suspend a Qemu VM instance
Parameters
**********
- **project_id**: UUID for the project
- **vm_id**: UUID for the instance
- **project_id**: UUID for the project
Response status codes
**********************
@@ -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
**********************
@@ -52,8 +52,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
**********************
@@ -114,8 +114,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
**********************
@@ -9,10 +9,10 @@ Add a NIO to a VirtualBox VM instance
Parameters
**********
- **project_id**: UUID for the project
- **adapter_number**: Adapter where the nio should be added
- **port_number**: Port on the adapter (always 0)
- **vm_id**: UUID for the instance
- **adapter_number**: Adapter where the nio should be added
- **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
- **adapter_number**: Adapter from where the nio should be removed
- **port_number**: Port on the adapter (always 0)
- **vm_id**: UUID for the instance
- **adapter_number**: Adapter from where the nio should be removed
- **project_id**: UUID for the project
Response status codes
**********************
@@ -9,10 +9,10 @@ Start a packet capture on a VirtualBox VM instance
Parameters
**********
- **project_id**: UUID for the project
- **adapter_number**: Adapter to start a packet capture
- **port_number**: Port on the adapter (always 0)
- **vm_id**: UUID for the instance
- **adapter_number**: Adapter to start a packet capture
- **project_id**: UUID for the project
Response status codes
**********************
@@ -9,10 +9,10 @@ Stop a packet capture on a VirtualBox VM instance
Parameters
**********
- **project_id**: UUID for the project
- **adapter_number**: Adapter to stop a packet capture
- **port_number**: Port on the adapter (always 0)
- **vm_id**: UUID for the instance
- **adapter_number**: Adapter to stop a packet capture
- **project_id**: UUID for the project
Response status codes
**********************
@@ -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
**********************
@@ -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
**********************
@@ -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
**********************
@@ -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
**********************
@@ -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
**********************
@@ -9,8 +9,8 @@ Get a VMware VM instance
Parameters
**********
- **project_id**: UUID for the project
- **vm_id**: UUID for the instance
- **project_id**: UUID for the project
Response status codes
**********************
@@ -46,8 +46,8 @@ Update a VMware VM instance
Parameters
**********
- **project_id**: UUID for the project
- **vm_id**: UUID for the instance
- **project_id**: UUID for the project
Response status codes
**********************
@@ -102,8 +102,8 @@ Delete a VMware VM instance
Parameters
**********
- **project_id**: UUID for the project
- **vm_id**: UUID for the instance
- **project_id**: UUID for the project
Response status codes
**********************
@@ -9,10 +9,10 @@ Add a NIO to a VMware VM instance
Parameters
**********
- **project_id**: UUID for the project
- **adapter_number**: Adapter where the nio should be added
- **port_number**: Port on the adapter (always 0)
- **vm_id**: UUID for the instance
- **adapter_number**: Adapter where the nio should be added
- **project_id**: UUID for the project
Response status codes
**********************
@@ -27,10 +27,10 @@ Remove a NIO from a VMware VM instance
Parameters
**********
- **project_id**: UUID for the project
- **adapter_number**: Adapter from where the nio should be removed
- **port_number**: Port on the adapter (always 0)
- **vm_id**: UUID for the instance
- **adapter_number**: Adapter from where the nio should be removed
- **project_id**: UUID for the project
Response status codes
**********************
@@ -9,10 +9,10 @@ Start a packet capture on a VMware VM instance
Parameters
**********
- **project_id**: UUID for the project
- **adapter_number**: Adapter to start a packet capture
- **port_number**: Port on the adapter (always 0)
- **vm_id**: UUID for the instance
- **adapter_number**: Adapter to start a packet capture
- **project_id**: UUID for the project
Response status codes
**********************
@@ -9,10 +9,10 @@ Stop a packet capture on a VMware VM instance
Parameters
**********
- **project_id**: UUID for the project
- **adapter_number**: Adapter to stop a packet capture
- **port_number**: Port on the adapter (always 0)
- **vm_id**: UUID for the instance
- **adapter_number**: Adapter to stop a packet capture
- **project_id**: UUID for the project
Response status codes
**********************
@@ -9,8 +9,8 @@ Allocate a VMware VMnet interface on the server
Parameters
**********
- **project_id**: The UUID of the project
- **vm_id**: UUID for the instance
- **project_id**: The UUID of the project
Response status codes
**********************
@@ -9,8 +9,8 @@ Reload a VMware VM instance
Parameters
**********
- **project_id**: UUID for the project
- **vm_id**: UUID for the instance
- **project_id**: UUID for the project
Response status codes
**********************
@@ -9,8 +9,8 @@ Resume a suspended VMware VM instance
Parameters
**********
- **project_id**: UUID for the project
- **vm_id**: UUID for the instance
- **project_id**: UUID for the project
Response status codes
**********************
@@ -9,8 +9,8 @@ Start a VMware VM instance
Parameters
**********
- **project_id**: UUID for the project
- **vm_id**: UUID for the instance
- **project_id**: UUID for the project
Response status codes
**********************
@@ -9,8 +9,8 @@ Stop a VMware VM instance
Parameters
**********
- **project_id**: UUID for the project
- **vm_id**: UUID for the instance
- **project_id**: UUID for the project
Response status codes
**********************
@@ -9,8 +9,8 @@ Suspend a VMware VM instance
Parameters
**********
- **project_id**: UUID for the project
- **vm_id**: UUID for the instance
- **project_id**: UUID for the project
Response status codes
**********************
@@ -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
**********************
@@ -49,8 +49,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
**********************
@@ -102,8 +102,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
**********************
@@ -9,10 +9,10 @@ Add a NIO to a VPCS instance
Parameters
**********
- **project_id**: UUID for the project
- **adapter_number**: Network adapter where the nio is located
- **port_number**: Port where the nio should be added
- **vm_id**: UUID for the instance
- **adapter_number**: Network adapter where the nio is located
- **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
- **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
- **adapter_number**: Network adapter where the nio is located
- **project_id**: UUID for the project
Response status codes
**********************
@@ -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
**********************
@@ -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
**********************
@@ -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
**********************