Update the documentation

This commit is contained in:
Julien Duponchelle committed 2017-03-06 14:35:39 +01:00
1 parent 8b7035b185
commit 54131bc9bb
319 files changed
+921 -5755

No files matched your search

@@ -13,8 +13,8 @@ Parameters
Response status codes
**********************
- **400**: Invalid request
- **201**: Instance created
- **400**: Invalid request
- **409**: Conflict
Input
@@ -9,8 +9,8 @@ Get an Ethernet switch instance
Parameters
**********
- **node_id**: Node UUID
- **project_id**: Project UUID
- **node_id**: Node UUID
Response status codes
**********************
@@ -38,8 +38,8 @@ Update an Ethernet switch instance
Parameters
**********
- **node_id**: Node UUID
- **project_id**: Project UUID
- **node_id**: Node UUID
Response status codes
**********************
@@ -100,12 +100,12 @@ Delete an Ethernet switch instance
Parameters
**********
- **node_id**: Node UUID
- **project_id**: Project UUID
- **node_id**: Node UUID
Response status codes
**********************
- **204**: Instance deleted
- **400**: Invalid request
- **404**: Instance doesn't exist
- **204**: Instance deleted
@@ -9,15 +9,15 @@ Add a NIO to an Ethernet switch instance
Parameters
**********
- **adapter_number**: Adapter on the switch (always 0)
- **node_id**: Node UUID
- **project_id**: Project UUID
- **node_id**: Node UUID
- **adapter_number**: Adapter on the switch (always 0)
- **port_number**: Port on the switch
Response status codes
**********************
- **400**: Invalid request
- **201**: NIO created
- **400**: Invalid request
- **404**: Instance doesn't exist
@@ -27,14 +27,14 @@ Remove a NIO from an Ethernet switch instance
Parameters
**********
- **adapter_number**: Adapter on the switch (always 0)
- **node_id**: Node UUID
- **project_id**: Project UUID
- **node_id**: Node UUID
- **adapter_number**: Adapter on the switch (always 0)
- **port_number**: Port on the switch
Response status codes
**********************
- **204**: NIO deleted
- **400**: Invalid request
- **404**: Instance doesn't exist
- **204**: NIO deleted
@@ -9,9 +9,9 @@ Start a packet capture on an Ethernet switch instance
Parameters
**********
- **adapter_number**: Adapter on the switch (always 0)
- **node_id**: Node UUID
- **project_id**: Project UUID
- **node_id**: Node UUID
- **adapter_number**: Adapter on the switch (always 0)
- **port_number**: Port on the switch
Response status codes
@@ -27,6 +27,6 @@ Input
<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>
<tr><td>data_link_type</td> <td> </td> <td>enum</td> <td>Possible values: DLT_ATM_RFC1483, DLT_EN10MB, DLT_FRELAY, DLT_C_HDLC, DLT_PPP_SERIAL</td> </tr>
</table>
@@ -9,14 +9,14 @@ Stop a packet capture on an Ethernet switch instance
Parameters
**********
- **adapter_number**: Adapter on the switch (always 0)
- **node_id**: Node UUID
- **project_id**: Project UUID
- **node_id**: Node UUID
- **adapter_number**: Adapter on the switch (always 0)
- **port_number**: Port on the switch
Response status codes
**********************
- **204**: Capture stopped
- **400**: Invalid request
- **404**: Instance doesn't exist
- **204**: Capture stopped
@@ -9,12 +9,12 @@ Start an Ethernet switch
Parameters
**********
- **node_id**: Node UUID
- **project_id**: Project UUID
- **node_id**: Node UUID
Response status codes
**********************
- **204**: Instance started
- **400**: Invalid request
- **404**: Instance doesn't exist
- **204**: Instance started
@@ -9,12 +9,12 @@ Stop an Ethernet switch
Parameters
**********
- **node_id**: Node UUID
- **project_id**: Project UUID
- **node_id**: Node UUID
Response status codes
**********************
- **204**: Instance stopped
- **400**: Invalid request
- **404**: Instance doesn't exist
- **204**: Instance stopped
@@ -9,12 +9,12 @@ Suspend an Ethernet switch
Parameters
**********
- **node_id**: Node UUID
- **project_id**: Project UUID
- **node_id**: Node UUID
Response status codes
**********************
- **204**: Instance suspended
- **400**: Invalid request
- **404**: Instance doesn't exist
- **204**: Instance suspended