Add documentation

docs/api/v2/compute/qemu/projectsprojectidqemunodesnodeidadaptersadapternumberdportsportnumberdstartcapture.rst

@@ -0,0 +1,32 @@
+/v2/compute/projects/{project_id}/qemu/nodes/{node_id}/adapters/{adapter_number:\d+}/ports/{port_number:\d+}/start_capture
+------------------------------------------------------------------------------------------------------------------------------------------
+
+.. contents::
+
+POST /v2/compute/projects/**{project_id}**/qemu/nodes/**{node_id}**/adapters/**{adapter_number:\d+}**/ports/**{port_number:\d+}**/start_capture
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+Start a packet capture on a Qemu VM instance
+
+Parameters
+**********
+- **port_number**: Port on the adapter (always 0)
+- **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>
+

docs/api/v2/compute/qemu/projectsprojectidqemunodesnodeidadaptersadapternumberdportsportnumberdstopcapture.rst

@@ -0,0 +1,22 @@
+/v2/compute/projects/{project_id}/qemu/nodes/{node_id}/adapters/{adapter_number:\d+}/ports/{port_number:\d+}/stop_capture
+------------------------------------------------------------------------------------------------------------------------------------------
+
+.. contents::
+
+POST /v2/compute/projects/**{project_id}**/qemu/nodes/**{node_id}**/adapters/**{adapter_number:\d+}**/ports/**{port_number:\d+}**/stop_capture
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+Stop a packet capture on a Qemu VM instance
+
+Parameters
+**********
+- **port_number**: Port on the adapter (always 0)
+- **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
+

docs/api/v2/controller/server/settings.rst

@@ -0,0 +1,34 @@
+/v2/settings
+------------------------------------------------------------------------------------------------------------------------------------------
+
+.. contents::
+
+GET /v2/settings
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+Retrieve gui settings from the server. Temporary will we removed in later release
+
+Response status codes
+**********************
+- **200**: OK
+
+Sample session
+***************
+
+
+.. literalinclude:: ../../../examples/controller_get_settings.txt
+
+
+POST /v2/settings
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+Write gui settings on the server. Temporary will we removed in later releas
+
+Response status codes
+**********************
+- **201**: Writed
+
+Sample session
+***************
+
+
+.. literalinclude:: ../../../examples/controller_post_settings.txt
+

docs/api/v2/controller/symbol.rst

@@ -0,0 +1,8 @@
+Symbol
+-----------------------------
+
+.. toctree::
+   :glob:
+   :maxdepth: 2
+
+   symbol/*

docs/api/v2/controller/symbol/symbols.rst

@@ -0,0 +1,19 @@
+/v2/symbols
+------------------------------------------------------------------------------------------------------------------------------------------
+
+.. contents::
+
+GET /v2/symbols
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+List of symbols
+
+Response status codes
+**********************
+- **200**: Symbols list returned
+
+Sample session
+***************
+
+
+.. literalinclude:: ../../../examples/controller_get_symbols.txt
+

docs/api/v2/controller/symbol/symbolssymbolidraw.rst

@@ -0,0 +1,22 @@
+/v2/symbols/{symbol_id:.+}/raw
+------------------------------------------------------------------------------------------------------------------------------------------
+
+.. contents::
+
+GET /v2/symbols/**{symbol_id:.+}**/raw
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+Get the symbol file
+
+Response status codes
+**********************
+- **200**: Symbol returned
+
+
+POST /v2/symbols/**{symbol_id:.+}**/raw
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+Write the symbol file
+
+Response status codes
+**********************
+- **200**: Symbol returned
+