Rebuild doc for drawing

This commit is contained in:
Julien Duponchelle committed 2016-06-23 12:29:15 +02:00
1 parent 5a410155f7
commit c8f37381f4
117 files changed
+340 -286

No files matched your search

@@ -9,8 +9,8 @@ Stop a packet capture on an ATM switch instance
Parameters
**********
- **project_id**: Project UUID
- **port_number**: Port on the switch
- **project_id**: Project UUID
- **node_id**: Node UUID
- **adapter_number**: Adapter on the switch (always 0)
@@ -9,8 +9,8 @@ Add a NIO to an ATM switch instance
Parameters
**********
- **project_id**: Project UUID
- **port_number**: Port on the switch
- **project_id**: Project UUID
- **node_id**: Node UUID
- **adapter_number**: Adapter on the switch (always 0)
@@ -27,8 +27,8 @@ Remove a NIO from an ATM switch instance
Parameters
**********
- **project_id**: Project UUID
- **port_number**: Port on the switch
- **project_id**: Project UUID
- **node_id**: Node UUID
- **adapter_number**: Adapter on the switch (always 0)
@@ -9,8 +9,8 @@ Start a packet capture on an ATM switch instance
Parameters
**********
- **project_id**: Project UUID
- **port_number**: Port on the switch
- **project_id**: Project UUID
- **node_id**: Node UUID
- **adapter_number**: Adapter on the switch (always 0)
@@ -9,8 +9,8 @@ Add a NIO to a cloud instance
Parameters
**********
- **project_id**: Project UUID
- **port_number**: Port on the cloud
- **project_id**: Project UUID
- **node_id**: Node UUID
- **adapter_number**: Adapter on the cloud (always 0)
@@ -27,8 +27,8 @@ Remove a NIO from a cloud instance
Parameters
**********
- **project_id**: Project UUID
- **port_number**: Port on the cloud
- **project_id**: Project UUID
- **node_id**: Node UUID
- **adapter_number**: Adapter on the cloud (always 0)
@@ -9,8 +9,8 @@ Start a packet capture on a cloud instance
Parameters
**********
- **project_id**: Project UUID
- **port_number**: Port on the cloud
- **project_id**: Project UUID
- **node_id**: Node UUID
- **adapter_number**: Adapter on the cloud (always 0)
@@ -9,8 +9,8 @@ Stop a packet capture on a cloud instance
Parameters
**********
- **project_id**: Project UUID
- **port_number**: Port on the cloud
- **project_id**: Project UUID
- **node_id**: Node UUID
- **adapter_number**: Adapter on the cloud (always 0)
@@ -9,8 +9,8 @@ Add a NIO to a Docker container
Parameters
**********
- **project_id**: Project UUID
- **port_number**: Port on the adapter
- **project_id**: Project UUID
- **node_id**: Node UUID
- **adapter_number**: Adapter where the nio should be added
@@ -33,8 +33,8 @@ Remove a NIO from a Docker container
Parameters
**********
- **project_id**: Project UUID
- **port_number**: Port on the adapter
- **project_id**: Project UUID
- **node_id**: Node UUID
- **adapter_number**: Adapter where the nio should be added
@@ -9,8 +9,8 @@ Start a packet capture on a Docker container instance
Parameters
**********
- **project_id**: Project UUID
- **port_number**: Port on the adapter
- **project_id**: Project UUID
- **node_id**: Node UUID
- **adapter_number**: Adapter to start a packet capture
@@ -9,8 +9,8 @@ Stop a packet capture on a Docker container instance
Parameters
**********
- **project_id**: Project UUID
- **port_number**: Port on the adapter (always 0)
- **project_id**: Project UUID
- **node_id**: Node UUID
- **adapter_number**: Adapter to stop a packet capture
@@ -9,8 +9,8 @@ Add a NIO to a Dynamips VM instance
Parameters
**********
- **project_id**: Project UUID
- **port_number**: Port on the adapter
- **project_id**: Project UUID
- **node_id**: Node UUID
- **adapter_number**: Adapter where the nio should be added
@@ -27,8 +27,8 @@ Remove a NIO from a Dynamips VM instance
Parameters
**********
- **project_id**: Project UUID
- **port_number**: Port on the adapter
- **project_id**: Project UUID
- **node_id**: Node UUID
- **adapter_number**: Adapter from where the nio should be removed
@@ -9,8 +9,8 @@ Start a packet capture on a Dynamips VM instance
Parameters
**********
- **project_id**: Project UUID
- **port_number**: Port on the adapter
- **project_id**: Project UUID
- **node_id**: Node UUID
- **adapter_number**: Adapter to start a packet capture
@@ -9,8 +9,8 @@ Stop a packet capture on a Dynamips VM instance
Parameters
**********
- **project_id**: Project UUID
- **port_number**: Port on the adapter (always 0)
- **project_id**: Project UUID
- **node_id**: Node UUID
- **adapter_number**: Adapter to stop a packet capture
@@ -9,8 +9,8 @@ Add a NIO to an Ethernet hub instance
Parameters
**********
- **project_id**: Project UUID
- **port_number**: Port on the hub
- **project_id**: Project UUID
- **node_id**: Node UUID
- **adapter_number**: Adapter on the hub (always 0)
@@ -27,8 +27,8 @@ Remove a NIO from an Ethernet hub instance
Parameters
**********
- **project_id**: Project UUID
- **port_number**: Port on the hub
- **project_id**: Project UUID
- **node_id**: Node UUID
- **adapter_number**: Adapter on the hub (always 0)
@@ -9,8 +9,8 @@ Start a packet capture on an Ethernet hub instance
Parameters
**********
- **project_id**: Project UUID
- **port_number**: Port on the hub
- **project_id**: Project UUID
- **node_id**: Node UUID
- **adapter_number**: Adapter on the hub (always 0)
@@ -9,8 +9,8 @@ Stop a packet capture on an Ethernet hub instance
Parameters
**********
- **project_id**: Project UUID
- **port_number**: Port on the hub
- **project_id**: Project UUID
- **node_id**: Node UUID
- **adapter_number**: Adapter on the hub (always 0)
@@ -9,8 +9,8 @@ Add a NIO to an Ethernet switch instance
Parameters
**********
- **project_id**: Project UUID
- **port_number**: Port on the switch
- **project_id**: Project UUID
- **node_id**: Node UUID
- **adapter_number**: Adapter on the switch (always 0)
@@ -27,8 +27,8 @@ Remove a NIO from an Ethernet switch instance
Parameters
**********
- **project_id**: Project UUID
- **port_number**: Port on the switch
- **project_id**: Project UUID
- **node_id**: Node UUID
- **adapter_number**: Adapter on the switch (always 0)
@@ -9,8 +9,8 @@ Start a packet capture on an Ethernet switch instance
Parameters
**********
- **project_id**: Project UUID
- **port_number**: Port on the switch
- **project_id**: Project UUID
- **node_id**: Node UUID
- **adapter_number**: Adapter on the switch (always 0)
@@ -9,8 +9,8 @@ Stop a packet capture on an Ethernet switch instance
Parameters
**********
- **project_id**: Project UUID
- **port_number**: Port on the switch
- **project_id**: Project UUID
- **node_id**: Node UUID
- **adapter_number**: Adapter on the switch (always 0)
@@ -9,8 +9,8 @@ Add a NIO to a Frame Relay switch instance
Parameters
**********
- **project_id**: Project UUID
- **port_number**: Port on the switch
- **project_id**: Project UUID
- **node_id**: Node UUID
- **adapter_number**: Adapter on the switch (always 0)
@@ -27,8 +27,8 @@ Remove a NIO from a Frame Relay switch instance
Parameters
**********
- **project_id**: Project UUID
- **port_number**: Port on the switch
- **project_id**: Project UUID
- **node_id**: Node UUID
- **adapter_number**: Adapter on the switch (always 0)
@@ -9,8 +9,8 @@ Start a packet capture on a Frame Relay switch instance
Parameters
**********
- **project_id**: Project UUID
- **port_number**: Port on the switch
- **project_id**: Project UUID
- **node_id**: Node UUID
- **adapter_number**: Adapter on the switch (always 0)
@@ -9,8 +9,8 @@ Stop a packet capture on a Frame Relay switch instance
Parameters
**********
- **project_id**: Project UUID
- **port_number**: Port on the switch
- **project_id**: Project UUID
- **node_id**: Node UUID
- **adapter_number**: Adapter on the switch (always 0)
@@ -9,8 +9,8 @@ Add a NIO to a IOU instance
Parameters
**********
- **project_id**: Project UUID
- **port_number**: Port where the nio should be added
- **project_id**: Project UUID
- **node_id**: Node UUID
- **adapter_number**: Network adapter where the nio is located
@@ -33,8 +33,8 @@ Remove a NIO from a IOU instance
Parameters
**********
- **project_id**: Project UUID
- **port_number**: Port from where the nio should be removed
- **project_id**: Project UUID
- **node_id**: Node UUID
- **adapter_number**: Network adapter where the nio is located
@@ -9,8 +9,8 @@ Start a packet capture on an IOU VM instance
Parameters
**********
- **project_id**: Project UUID
- **port_number**: Port on the adapter
- **project_id**: Project UUID
- **node_id**: Node UUID
- **adapter_number**: Adapter to start a packet capture
@@ -9,8 +9,8 @@ Stop a packet capture on an IOU VM instance
Parameters
**********
- **project_id**: Project UUID
- **port_number**: Port on the adapter (always 0)
- **project_id**: Project UUID
- **node_id**: Node UUID
- **adapter_number**: Adapter to stop a packet capture
@@ -9,8 +9,8 @@ Add a NIO to a Qemu VM instance
Parameters
**********
- **project_id**: Project UUID
- **port_number**: Port on the adapter (always 0)
- **project_id**: Project UUID
- **node_id**: Node UUID
- **adapter_number**: Network adapter where the nio is located
@@ -33,8 +33,8 @@ Remove a NIO from a Qemu VM instance
Parameters
**********
- **project_id**: Project UUID
- **port_number**: Port on the adapter (always 0)
- **project_id**: Project UUID
- **node_id**: Node UUID
- **adapter_number**: Network adapter where the nio is located
@@ -9,8 +9,8 @@ Add a NIO to a VirtualBox VM instance
Parameters
**********
- **project_id**: Project UUID
- **port_number**: Port on the adapter (always 0)
- **project_id**: Project UUID
- **node_id**: Node UUID
- **adapter_number**: Adapter where the nio should be added
@@ -33,8 +33,8 @@ Remove a NIO from a VirtualBox VM instance
Parameters
**********
- **project_id**: Project UUID
- **port_number**: Port on the adapter (always 0)
- **project_id**: Project UUID
- **node_id**: Node UUID
- **adapter_number**: Adapter from where the nio should be removed
@@ -9,8 +9,8 @@ Start a packet capture on a VirtualBox VM instance
Parameters
**********
- **project_id**: Project UUID
- **port_number**: Port on the adapter (always 0)
- **project_id**: Project UUID
- **node_id**: Node UUID
- **adapter_number**: Adapter to start a packet capture
@@ -9,8 +9,8 @@ Stop a packet capture on a VirtualBox VM instance
Parameters
**********
- **project_id**: Project UUID
- **port_number**: Port on the adapter (always 0)
- **project_id**: Project UUID
- **node_id**: Node UUID
- **adapter_number**: Adapter to stop a packet capture
@@ -9,8 +9,8 @@ Add a NIO to a VMware VM instance
Parameters
**********
- **project_id**: Project UUID
- **port_number**: Port on the adapter (always 0)
- **project_id**: Project UUID
- **node_id**: Node UUID
- **adapter_number**: Adapter where the nio should be added
@@ -27,8 +27,8 @@ Remove a NIO from a VMware VM instance
Parameters
**********
- **project_id**: Project UUID
- **port_number**: Port on the adapter (always 0)
- **project_id**: Project UUID
- **node_id**: Node UUID
- **adapter_number**: Adapter from where the nio should be removed
@@ -9,8 +9,8 @@ Start a packet capture on a VMware VM instance
Parameters
**********
- **project_id**: Project UUID
- **port_number**: Port on the adapter (always 0)
- **project_id**: Project UUID
- **node_id**: Node UUID
- **adapter_number**: Adapter to start a packet capture
@@ -9,8 +9,8 @@ Stop a packet capture on a VMware VM instance
Parameters
**********
- **project_id**: Project UUID
- **port_number**: Port on the adapter (always 0)
- **project_id**: Project UUID
- **node_id**: Node UUID
- **adapter_number**: Adapter to stop a packet capture
@@ -9,8 +9,8 @@ Add a NIO to a VPCS instance
Parameters
**********
- **project_id**: Project UUID
- **port_number**: Port where the nio should be added
- **project_id**: Project UUID
- **node_id**: Node UUID
- **adapter_number**: Network adapter where the nio is located
@@ -33,8 +33,8 @@ Remove a NIO from a VPCS instance
Parameters
**********
- **project_id**: Project UUID
- **port_number**: Port from where the nio should be removed
- **project_id**: Project UUID
- **node_id**: Node UUID
- **adapter_number**: Network adapter where the nio is located
@@ -0,0 +1,32 @@
/v2/compute/projects/{project_id}/vpcs/nodes/{node_id}/adapters/{adapter_number:\d+}/ports/{port_number:\d+}/start_capture
------------------------------------------------------------------------------------------------------------------------------------------
.. contents::
POST /v2/compute/projects/**{project_id}**/vpcs/nodes/**{node_id}**/adapters/**{adapter_number:\d+}**/ports/**{port_number:\d+}**/start_capture
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Start a packet capture on a VPCS instance
Parameters
**********
- **port_number**: Port on the adapter
- **project_id**: Project UUID
- **node_id**: Node UUID
- **adapter_number**: Adapter to start a packet capture
Response status codes
**********************
- **200**: Capture started
- **400**: Invalid request
- **404**: Instance doesn't exist
Input
*******
.. raw:: html
<table>
<tr> <th>Name</th> <th>Mandatory</th> <th>Type</th> <th>Description</th> </tr>
<tr><td>capture_file_name</td> <td>&#10004;</td> <td>string</td> <td>Capture file name</td> </tr>
<tr><td>data_link_type</td> <td> </td> <td>enum</td> <td>Possible values: DLT_ATM_RFC1483, DLT_EN10MB, DLT_FRELAY, DLT_C_HDLC</td> </tr>
</table>
@@ -0,0 +1,22 @@
/v2/compute/projects/{project_id}/vpcs/nodes/{node_id}/adapters/{adapter_number:\d+}/ports/{port_number:\d+}/stop_capture
------------------------------------------------------------------------------------------------------------------------------------------
.. contents::
POST /v2/compute/projects/**{project_id}**/vpcs/nodes/**{node_id}**/adapters/**{adapter_number:\d+}**/ports/**{port_number:\d+}**/stop_capture
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Stop a packet capture on a VPCS instance
Parameters
**********
- **port_number**: Port on the adapter
- **project_id**: Project UUID
- **node_id**: Node UUID
- **adapter_number**: Adapter to stop a packet capture
Response status codes
**********************
- **400**: Invalid request
- **404**: Instance doesn't exist
- **204**: Capture stopped
File renamed without changes.
@@ -41,9 +41,9 @@ Input
<table>
<tr> <th>Name</th> <th>Mandatory</th> <th>Type</th> <th>Description</th> </tr>
<tr><td>drawing_id</td> <td> </td> <td>string</td> <td>Drawing UUID</td> </tr>
<tr><td>project_id</td> <td> </td> <td>string</td> <td>Project UUID</td> </tr>
<tr><td>rotation</td> <td> </td> <td>integer</td> <td>Rotation of the element</td> </tr>
<tr><td>drawing_id</td> <td> </td> <td>string</td> <td>Drawing UUID</td> </tr>
<tr><td>svg</td> <td> </td> <td>string</td> <td>SVG content of the drawing</td> </tr>
<tr><td>x</td> <td> </td> <td>integer</td> <td>X property</td> </tr>
<tr><td>y</td> <td> </td> <td>integer</td> <td>Y property</td> </tr>
@@ -56,9 +56,9 @@ Output
<table>
<tr> <th>Name</th> <th>Mandatory</th> <th>Type</th> <th>Description</th> </tr>
<tr><td>drawing_id</td> <td> </td> <td>string</td> <td>Drawing UUID</td> </tr>
<tr><td>project_id</td> <td> </td> <td>string</td> <td>Project UUID</td> </tr>
<tr><td>rotation</td> <td> </td> <td>integer</td> <td>Rotation of the element</td> </tr>
<tr><td>drawing_id</td> <td> </td> <td>string</td> <td>Drawing UUID</td> </tr>
<tr><td>svg</td> <td> </td> <td>string</td> <td>SVG content of the drawing</td> </tr>
<tr><td>x</td> <td> </td> <td>integer</td> <td>X property</td> </tr>
<tr><td>y</td> <td> </td> <td>integer</td> <td>Y property</td> </tr>
@@ -23,9 +23,9 @@ Input
<table>
<tr> <th>Name</th> <th>Mandatory</th> <th>Type</th> <th>Description</th> </tr>
<tr><td>drawing_id</td> <td> </td> <td>string</td> <td>Drawing UUID</td> </tr>
<tr><td>project_id</td> <td> </td> <td>string</td> <td>Project UUID</td> </tr>
<tr><td>rotation</td> <td> </td> <td>integer</td> <td>Rotation of the element</td> </tr>
<tr><td>drawing_id</td> <td> </td> <td>string</td> <td>Drawing UUID</td> </tr>
<tr><td>svg</td> <td> </td> <td>string</td> <td>SVG content of the drawing</td> </tr>
<tr><td>x</td> <td> </td> <td>integer</td> <td>X property</td> </tr>
<tr><td>y</td> <td> </td> <td>integer</td> <td>Y property</td> </tr>
@@ -38,9 +38,9 @@ Output
<table>
<tr> <th>Name</th> <th>Mandatory</th> <th>Type</th> <th>Description</th> </tr>
<tr><td>drawing_id</td> <td> </td> <td>string</td> <td>Drawing UUID</td> </tr>
<tr><td>project_id</td> <td> </td> <td>string</td> <td>Project UUID</td> </tr>
<tr><td>rotation</td> <td> </td> <td>integer</td> <td>Rotation of the element</td> </tr>
<tr><td>drawing_id</td> <td> </td> <td>string</td> <td>Drawing UUID</td> </tr>
<tr><td>svg</td> <td> </td> <td>string</td> <td>SVG content of the drawing</td> </tr>
<tr><td>x</td> <td> </td> <td>integer</td> <td>X property</td> </tr>
<tr><td>y</td> <td> </td> <td>integer</td> <td>Y property</td> </tr>