From 0977af1c00d1af0a1612708be184b1daeb713d42 Mon Sep 17 00:00:00 2001 From: Julien Duponchelle Date: Wed, 18 Feb 2015 11:06:13 +0100 Subject: [PATCH] Add a dedicated glossary page --- ...ptersadapternumberdportsportnumberdnio.rst | 4 +-- ...ternumberdportsportnumberdstartcapture.rst | 2 +- ...pternumberdportsportnumberdstopcapture.rst | 2 +- docs/api/iou/v1projectsprojectidiouvms.rst | 4 +-- .../api/iou/v1projectsprojectidiouvmsvmid.rst | 5 ++-- ...ptersadapternumberdportsportnumberdnio.rst | 4 +-- ...ternumberdportsportnumberdstartcapture.rst | 2 +- ...pternumberdportsportnumberdstopcapture.rst | 2 +- ...ojectsprojectidiouvmsvmidinitialconfig.rst | 25 ++++++++++++++++++ ...ptersadapternumberdportsportnumberdnio.rst | 4 +-- ...ternumberdportsportnumberdstartcapture.rst | 2 +- ...pternumberdportsportnumberdstopcapture.rst | 2 +- ...ptersadapternumberdportsportnumberdnio.rst | 4 +-- docs/general.rst | 26 ++++--------------- docs/glossary.rst | 20 ++++++++++++++ docs/index.rst | 1 + 16 files changed, 70 insertions(+), 39 deletions(-) create mode 100644 docs/api/iou/v1projectsprojectidiouvmsvmidinitialconfig.rst create mode 100644 docs/glossary.rst diff --git a/docs/api/dynamips_vm/v1projectsprojectiddynamipsvmsvmidadaptersadapternumberdportsportnumberdnio.rst b/docs/api/dynamips_vm/v1projectsprojectiddynamipsvmsvmidadaptersadapternumberdportsportnumberdnio.rst index ddff9476..4db67440 100644 --- a/docs/api/dynamips_vm/v1projectsprojectiddynamipsvmsvmidadaptersadapternumberdportsportnumberdnio.rst +++ b/docs/api/dynamips_vm/v1projectsprojectiddynamipsvmsvmidadaptersadapternumberdportsportnumberdnio.rst @@ -9,9 +9,9 @@ Add a NIO to a Dynamips VM instance Parameters ********** -- **adapter_number**: Adapter where the nio should be added - **vm_id**: UUID for the instance - **port_number**: Port on the adapter +- **adapter_number**: Adapter where the nio should be added - **project_id**: UUID for the project Response status codes @@ -27,9 +27,9 @@ Remove a NIO from a Dynamips VM instance Parameters ********** -- **adapter_number**: Adapter from where the nio should be removed - **vm_id**: UUID for the instance - **port_number**: Port on the adapter +- **adapter_number**: Adapter from where the nio should be removed - **project_id**: UUID for the project Response status codes diff --git a/docs/api/dynamips_vm/v1projectsprojectiddynamipsvmsvmidadaptersadapternumberdportsportnumberdstartcapture.rst b/docs/api/dynamips_vm/v1projectsprojectiddynamipsvmsvmidadaptersadapternumberdportsportnumberdstartcapture.rst index 43c9c0fe..a00b56bc 100644 --- a/docs/api/dynamips_vm/v1projectsprojectiddynamipsvmsvmidadaptersadapternumberdportsportnumberdstartcapture.rst +++ b/docs/api/dynamips_vm/v1projectsprojectiddynamipsvmsvmidadaptersadapternumberdportsportnumberdstartcapture.rst @@ -9,9 +9,9 @@ Start a packet capture on a Dynamips VM instance Parameters ********** -- **adapter_number**: Adapter to start a packet capture - **vm_id**: UUID for the instance - **port_number**: Port on the adapter +- **adapter_number**: Adapter to start a packet capture - **project_id**: UUID for the project Response status codes diff --git a/docs/api/dynamips_vm/v1projectsprojectiddynamipsvmsvmidadaptersadapternumberdportsportnumberdstopcapture.rst b/docs/api/dynamips_vm/v1projectsprojectiddynamipsvmsvmidadaptersadapternumberdportsportnumberdstopcapture.rst index 1114fae5..12efdbdb 100644 --- a/docs/api/dynamips_vm/v1projectsprojectiddynamipsvmsvmidadaptersadapternumberdportsportnumberdstopcapture.rst +++ b/docs/api/dynamips_vm/v1projectsprojectiddynamipsvmsvmidadaptersadapternumberdportsportnumberdstopcapture.rst @@ -9,9 +9,9 @@ Stop a packet capture on a Dynamips VM instance Parameters ********** -- **adapter_number**: Adapter to stop a packet capture - **vm_id**: UUID for the instance - **port_number**: Port on the adapter (always 0) +- **adapter_number**: Adapter to stop a packet capture - **project_id**: UUID for the project Response status codes diff --git a/docs/api/iou/v1projectsprojectidiouvms.rst b/docs/api/iou/v1projectsprojectidiouvms.rst index 92cebf36..281eccd2 100644 --- a/docs/api/iou/v1projectsprojectidiouvms.rst +++ b/docs/api/iou/v1projectsprojectidiouvms.rst @@ -25,8 +25,7 @@ Input Name Mandatory Type Description console ['integer', 'null'] console TCP port ethernet_adapters integer How many ethernet adapters are connected to the IOU - initial_config ['string', 'null'] Initial configuration of the IOU - iourc_path string Path of iourc + initial_config_content ['string', 'null'] Initial configuration of the IOU l1_keepalives ['boolean', 'null'] Always up ethernet interface name ✔ string IOU VM name nvram ['integer', 'null'] Allocated NVRAM KB @@ -44,6 +43,7 @@ Output Name Mandatory Type Description console ✔ integer console TCP port ethernet_adapters ✔ integer How many ethernet adapters are connected to the IOU + initial_config ✔ ['string', 'null'] Path of the initial config content relative to project directory l1_keepalives ✔ boolean Always up ethernet interface name ✔ string IOU VM name nvram ✔ integer Allocated NVRAM KB diff --git a/docs/api/iou/v1projectsprojectidiouvmsvmid.rst b/docs/api/iou/v1projectsprojectidiouvmsvmid.rst index 0fdbe2e2..a3ea1cbe 100644 --- a/docs/api/iou/v1projectsprojectidiouvmsvmid.rst +++ b/docs/api/iou/v1projectsprojectidiouvmsvmid.rst @@ -26,6 +26,7 @@ Output Name Mandatory Type Description console ✔ integer console TCP port ethernet_adapters ✔ integer How many ethernet adapters are connected to the IOU + initial_config ✔ ['string', 'null'] Path of the initial config content relative to project directory l1_keepalives ✔ boolean Always up ethernet interface name ✔ string IOU VM name nvram ✔ integer Allocated NVRAM KB @@ -61,8 +62,7 @@ Input Name Mandatory Type Description console ['integer', 'null'] console TCP port ethernet_adapters ['integer', 'null'] How many ethernet adapters are connected to the IOU - initial_config ['string', 'null'] Initial configuration of the IOU - iourc_path ['string', 'null'] Path of iourc + initial_config_content ['string', 'null'] Initial configuration of the IOU l1_keepalives ['boolean', 'null'] Always up ethernet interface name ['string', 'null'] IOU VM name nvram ['integer', 'null'] Allocated NVRAM KB @@ -79,6 +79,7 @@ Output Name Mandatory Type Description console ✔ integer console TCP port ethernet_adapters ✔ integer How many ethernet adapters are connected to the IOU + initial_config ✔ ['string', 'null'] Path of the initial config content relative to project directory l1_keepalives ✔ boolean Always up ethernet interface name ✔ string IOU VM name nvram ✔ integer Allocated NVRAM KB diff --git a/docs/api/iou/v1projectsprojectidiouvmsvmidadaptersadapternumberdportsportnumberdnio.rst b/docs/api/iou/v1projectsprojectidiouvmsvmidadaptersadapternumberdportsportnumberdnio.rst index 9e2ce5a8..59088dce 100644 --- a/docs/api/iou/v1projectsprojectidiouvmsvmidadaptersadapternumberdportsportnumberdnio.rst +++ b/docs/api/iou/v1projectsprojectidiouvmsvmidadaptersadapternumberdportsportnumberdnio.rst @@ -9,9 +9,9 @@ Add a NIO to a IOU instance Parameters ********** -- **adapter_number**: Network adapter where the nio is located - **vm_id**: UUID for the instance - **port_number**: Port where the nio should be added +- **adapter_number**: Network adapter where the nio is located - **project_id**: UUID for the project Response status codes @@ -27,9 +27,9 @@ Remove a NIO from a IOU instance Parameters ********** -- **adapter_number**: Network adapter where the nio is located - **vm_id**: UUID for the instance - **port_number**: Port from where the nio should be removed +- **adapter_number**: Network adapter where the nio is located - **project_id**: UUID for the project Response status codes diff --git a/docs/api/iou/v1projectsprojectidiouvmsvmidadaptersadapternumberdportsportnumberdstartcapture.rst b/docs/api/iou/v1projectsprojectidiouvmsvmidadaptersadapternumberdportsportnumberdstartcapture.rst index fdd481c9..ff553a9c 100644 --- a/docs/api/iou/v1projectsprojectidiouvmsvmidadaptersadapternumberdportsportnumberdstartcapture.rst +++ b/docs/api/iou/v1projectsprojectidiouvmsvmidadaptersadapternumberdportsportnumberdstartcapture.rst @@ -9,9 +9,9 @@ Start a packet capture on a IOU VM instance Parameters ********** -- **adapter_number**: Adapter to start a packet capture - **vm_id**: UUID for the instance - **port_number**: Port on the adapter +- **adapter_number**: Adapter to start a packet capture - **project_id**: UUID for the project Response status codes diff --git a/docs/api/iou/v1projectsprojectidiouvmsvmidadaptersadapternumberdportsportnumberdstopcapture.rst b/docs/api/iou/v1projectsprojectidiouvmsvmidadaptersadapternumberdportsportnumberdstopcapture.rst index a2441a3d..dee6e612 100644 --- a/docs/api/iou/v1projectsprojectidiouvmsvmidadaptersadapternumberdportsportnumberdstopcapture.rst +++ b/docs/api/iou/v1projectsprojectidiouvmsvmidadaptersadapternumberdportsportnumberdstopcapture.rst @@ -9,9 +9,9 @@ Stop a packet capture on a IOU VM instance Parameters ********** -- **adapter_number**: Adapter to stop a packet capture - **vm_id**: UUID for the instance - **port_number**: Port on the adapter (always 0) +- **adapter_number**: Adapter to stop a packet capture - **project_id**: UUID for the project Response status codes diff --git a/docs/api/iou/v1projectsprojectidiouvmsvmidinitialconfig.rst b/docs/api/iou/v1projectsprojectidiouvmsvmidinitialconfig.rst new file mode 100644 index 00000000..f2cfdbfd --- /dev/null +++ b/docs/api/iou/v1projectsprojectidiouvmsvmidinitialconfig.rst @@ -0,0 +1,25 @@ +/v1/projects/{project_id}/iou/vms/{vm_id}/initial_config +---------------------------------------------------------------------------------------------------------------------- + +.. contents:: + +GET /v1/projects/**{project_id}**/iou/vms/**{vm_id}**/initial_config +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +Retrieve the initial config content + +Response status codes +********************** +- **200**: Initial config retrieved +- **400**: Invalid request +- **404**: Instance doesn't exist + +Output +******* +.. raw:: html + + + + + +
Name Mandatory Type Description
content ✔ ['string', 'null'] Content of the initial configuration file
path ✔ ['string', 'null'] Relative path on the server of the initial configuration file
+ diff --git a/docs/api/virtualbox/v1projectsprojectidvirtualboxvmsvmidadaptersadapternumberdportsportnumberdnio.rst b/docs/api/virtualbox/v1projectsprojectidvirtualboxvmsvmidadaptersadapternumberdportsportnumberdnio.rst index 726fa494..9d22751c 100644 --- a/docs/api/virtualbox/v1projectsprojectidvirtualboxvmsvmidadaptersadapternumberdportsportnumberdnio.rst +++ b/docs/api/virtualbox/v1projectsprojectidvirtualboxvmsvmidadaptersadapternumberdportsportnumberdnio.rst @@ -9,9 +9,9 @@ Add a NIO to a VirtualBox VM instance Parameters ********** -- **adapter_number**: Adapter where the nio should be added - **vm_id**: UUID for the instance - **port_number**: Port on the adapter (always 0) +- **adapter_number**: Adapter where the nio should be added - **project_id**: UUID for the project Response status codes @@ -27,9 +27,9 @@ Remove a NIO from a VirtualBox VM instance Parameters ********** -- **adapter_number**: Adapter from where the nio should be removed - **vm_id**: UUID for the instance - **port_number**: Port on the adapter (always) +- **adapter_number**: Adapter from where the nio should be removed - **project_id**: UUID for the project Response status codes diff --git a/docs/api/virtualbox/v1projectsprojectidvirtualboxvmsvmidadaptersadapternumberdportsportnumberdstartcapture.rst b/docs/api/virtualbox/v1projectsprojectidvirtualboxvmsvmidadaptersadapternumberdportsportnumberdstartcapture.rst index 67ff14c4..67bba0ab 100644 --- a/docs/api/virtualbox/v1projectsprojectidvirtualboxvmsvmidadaptersadapternumberdportsportnumberdstartcapture.rst +++ b/docs/api/virtualbox/v1projectsprojectidvirtualboxvmsvmidadaptersadapternumberdportsportnumberdstartcapture.rst @@ -9,9 +9,9 @@ Start a packet capture on a VirtualBox VM instance Parameters ********** -- **adapter_number**: Adapter to start a packet capture - **vm_id**: UUID for the instance - **port_number**: Port on the adapter (always 0) +- **adapter_number**: Adapter to start a packet capture - **project_id**: UUID for the project Response status codes diff --git a/docs/api/virtualbox/v1projectsprojectidvirtualboxvmsvmidadaptersadapternumberdportsportnumberdstopcapture.rst b/docs/api/virtualbox/v1projectsprojectidvirtualboxvmsvmidadaptersadapternumberdportsportnumberdstopcapture.rst index 1377be32..ea6fea53 100644 --- a/docs/api/virtualbox/v1projectsprojectidvirtualboxvmsvmidadaptersadapternumberdportsportnumberdstopcapture.rst +++ b/docs/api/virtualbox/v1projectsprojectidvirtualboxvmsvmidadaptersadapternumberdportsportnumberdstopcapture.rst @@ -9,9 +9,9 @@ Stop a packet capture on a VirtualBox VM instance Parameters ********** -- **adapter_number**: Adapter to stop a packet capture - **vm_id**: UUID for the instance - **port_number**: Port on the adapter (always 0) +- **adapter_number**: Adapter to stop a packet capture - **project_id**: UUID for the project Response status codes diff --git a/docs/api/vpcs/v1projectsprojectidvpcsvmsvmidadaptersadapternumberdportsportnumberdnio.rst b/docs/api/vpcs/v1projectsprojectidvpcsvmsvmidadaptersadapternumberdportsportnumberdnio.rst index bfb811dd..8be4efb3 100644 --- a/docs/api/vpcs/v1projectsprojectidvpcsvmsvmidadaptersadapternumberdportsportnumberdnio.rst +++ b/docs/api/vpcs/v1projectsprojectidvpcsvmsvmidadaptersadapternumberdportsportnumberdnio.rst @@ -9,9 +9,9 @@ Add a NIO to a VPCS instance Parameters ********** -- **adapter_number**: Network adapter where the nio is located - **vm_id**: UUID for the instance - **port_number**: Port where the nio should be added +- **adapter_number**: Network adapter where the nio is located - **project_id**: UUID for the project Response status codes @@ -27,9 +27,9 @@ Remove a NIO from a VPCS instance Parameters ********** -- **adapter_number**: Network adapter where the nio is located - **vm_id**: UUID for the instance - **port_number**: Port from where the nio should be removed +- **adapter_number**: Network adapter where the nio is located - **project_id**: UUID for the project Response status codes diff --git a/docs/general.rst b/docs/general.rst index 5e01f896..9c0855f7 100644 --- a/docs/general.rst +++ b/docs/general.rst @@ -1,3 +1,8 @@ +Communications +=============== + +All the communication are done over HTTP using JSON. + Errors ====== @@ -10,24 +15,3 @@ JSON like that "status": 409, "message": "Conflict" } - -Glossary -======== - -VM ---- - -A Virtual Machine (Dynamips, IOU, Qemu, VPCS...) - -Adapter -------- - -The physical network interface. The adapter can contain multiple ports. - -Port ----- - -A port is an opening on network adapter that cable plug into. - -For example a VM can have a serial and an ethernet adapter plugged in. -The ethernet adapter can have 4 ports. diff --git a/docs/glossary.rst b/docs/glossary.rst new file mode 100644 index 00000000..9192b9b5 --- /dev/null +++ b/docs/glossary.rst @@ -0,0 +1,20 @@ +Glossary +======== + +VM +--- + +A Virtual Machine (Dynamips, IOU, Qemu, VPCS...) + +Adapter +------- + +The physical network interface. The adapter can contain multiple ports. + +Port +---- + +A port is an opening on network adapter that cable plug into. + +For example a VM can have a serial and an ethernet adapter plugged in. +The ethernet adapter can have 4 ports. diff --git a/docs/index.rst b/docs/index.rst index a8a1fc27..74292e8a 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -4,6 +4,7 @@ Welcome to API documentation! .. toctree:: general + glossary development