NgTech-LTD/gns3-server
2
0 Fork 0
mirror of https://github.com/GNS3/gns3-server.git synced 2026-11-04 06:21:15 +02:00
Code Issues Packages Projects Releases Wiki Activity

Update the documentation

Browse Source
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
Download Patch File Download Diff File Expand all files Collapse all files

No files matched your search

docs/api/v2/controller/node/projectsprojectidnodes.rst
+1 -13
View File
@@ -13,8 +13,8 @@ Parameters
Response status codes
**********************
- **400**: Invalid request
- **201**: Instance created
- **400**: Invalid request
Input
*******
@@ -78,12 +78,6 @@ Output
<tr><td>z</td> <td> </td> <td>integer</td> <td>Z position of the node</td> </tr>
</table>
Sample session
***************
.. literalinclude:: ../../../examples/controller_post_projectsprojectidnodes.txt
GET /v2/projects/**{project_id}**/nodes
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -97,9 +91,3 @@ Response status codes
**********************
- **200**: List of nodes returned
Sample session
***************
.. literalinclude:: ../../../examples/controller_get_projectsprojectidnodes.txt
docs/api/v2/controller/node/projectsprojectidnodesnodeid.rst
+2 -20
View File
@@ -44,12 +44,6 @@ Output
<tr><td>z</td> <td> </td> <td>integer</td> <td>Z position of the node</td> </tr>
</table>
Sample session
***************
.. literalinclude:: ../../../examples/controller_get_projectsprojectidnodesnodeid.txt
PUT /v2/projects/**{project_id}**/nodes/**{node_id}**
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -123,12 +117,6 @@ Output
<tr><td>z</td> <td> </td> <td>integer</td> <td>Z position of the node</td> </tr>
</table>
Sample session
***************
.. literalinclude:: ../../../examples/controller_put_projectsprojectidnodesnodeid.txt
DELETE /v2/projects/**{project_id}**/nodes/**{node_id}**
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -136,18 +124,12 @@ Delete a node 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
Sample session
***************
.. literalinclude:: ../../../examples/controller_delete_projectsprojectidnodesnodeid.txt
docs/api/v2/controller/node/projectsprojectidnodesnodeiddynamipsautoidlepc.rst
+2 -8
View File
@@ -9,18 +9,12 @@ Compute the IDLE PC for a Dynamips node
Parameters
**********
- **node_id**: Node UUID
- **project_id**: Project UUID
- **node_id**: Node UUID
Response status codes
**********************
- **204**: Instance reloaded
- **400**: Invalid request
- **404**: Instance doesn't exist
- **204**: Instance reloaded
Sample session
***************
.. literalinclude:: ../../../examples/controller_get_projectsprojectidnodesnodeiddynamipsautoidlepc.txt
docs/api/v2/controller/node/projectsprojectidnodesnodeiddynamipsidlepcproposals.rst
+2 -8
View File
@@ -9,18 +9,12 @@ Compute a list of potential idle PC for a node
Parameters
**********
- **node_id**: Node UUID
- **project_id**: Project UUID
- **node_id**: Node UUID
Response status codes
**********************
- **204**: Instance reloaded
- **400**: Invalid request
- **404**: Instance doesn't exist
- **204**: Instance reloaded
Sample session
***************
.. literalinclude:: ../../../examples/controller_get_projectsprojectidnodesnodeiddynamipsidlepcproposals.txt
docs/api/v2/controller/node/projectsprojectidnodesnodeidfilespath.rst
+4 -4
View File
@@ -9,14 +9,14 @@ Get a file in the node directory
Parameters
**********
- **node_id**: Node UUID
- **project_id**: Project UUID
- **node_id**: Node UUID
Response status codes
**********************
- **204**: Instance reloaded
- **400**: Invalid request
- **404**: Instance doesn't exist
- **204**: Instance reloaded
POST /v2/projects/**{project_id}**/nodes/**{node_id}**/files/**{path:.+}**
@@ -25,12 +25,12 @@ Write a file in the node directory
Parameters
**********
- **node_id**: Node UUID
- **project_id**: Project UUID
- **node_id**: Node UUID
Response status codes
**********************
- **204**: Instance reloaded
- **400**: Invalid request
- **404**: Instance doesn't exist
- **204**: Instance reloaded
docs/api/v2/controller/node/projectsprojectidnodesnodeidreload.rst
+2 -8
View File
@@ -9,14 +9,14 @@ Reload a node instance
Parameters
**********
- **node_id**: Node UUID
- **project_id**: Project UUID
- **node_id**: Node UUID
Response status codes
**********************
- **204**: Instance reloaded
- **400**: Invalid request
- **404**: Instance doesn't exist
- **204**: Instance reloaded
Output
*******
@@ -49,9 +49,3 @@ Output
<tr><td>z</td> <td> </td> <td>integer</td> <td>Z position of the node</td> </tr>
</table>
Sample session
***************
.. literalinclude:: ../../../examples/controller_post_projectsprojectidnodesnodeidreload.txt
docs/api/v2/controller/node/projectsprojectidnodesnodeidstart.rst
+2 -8
View File
@@ -9,14 +9,14 @@ Start a node instance
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
Output
*******
@@ -49,9 +49,3 @@ Output
<tr><td>z</td> <td> </td> <td>integer</td> <td>Z position of the node</td> </tr>
</table>
Sample session
***************
.. literalinclude:: ../../../examples/controller_post_projectsprojectidnodesnodeidstart.txt
docs/api/v2/controller/node/projectsprojectidnodesnodeidstop.rst
+2 -8
View File
@@ -9,14 +9,14 @@ Stop a node instance
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
Output
*******
@@ -49,9 +49,3 @@ Output
<tr><td>z</td> <td> </td> <td>integer</td> <td>Z position of the node</td> </tr>
</table>
Sample session
***************
.. literalinclude:: ../../../examples/controller_post_projectsprojectidnodesnodeidstop.txt
docs/api/v2/controller/node/projectsprojectidnodesnodeidsuspend.rst
+2 -8
View File
@@ -9,14 +9,14 @@ Suspend a node instance
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
Output
*******
@@ -49,9 +49,3 @@ Output
<tr><td>z</td> <td> </td> <td>integer</td> <td>Z position of the node</td> </tr>
</table>
Sample session
***************
.. literalinclude:: ../../../examples/controller_post_projectsprojectidnodesnodeidsuspend.txt
docs/api/v2/controller/node/projectsprojectidnodesreload.rst
+1 -7
View File
@@ -13,9 +13,9 @@ Parameters
Response status codes
**********************
- **204**: All nodes successfully reloaded
- **400**: Invalid request
- **404**: Instance doesn't exist
- **204**: All nodes successfully reloaded
Output
*******
@@ -48,9 +48,3 @@ Output
<tr><td>z</td> <td> </td> <td>integer</td> <td>Z position of the node</td> </tr>
</table>
Sample session
***************
.. literalinclude:: ../../../examples/controller_post_projectsprojectidnodesreload.txt
docs/api/v2/controller/node/projectsprojectidnodesstart.rst
+1 -7
View File
@@ -13,9 +13,9 @@ Parameters
Response status codes
**********************
- **204**: All nodes successfully started
- **400**: Invalid request
- **404**: Instance doesn't exist
- **204**: All nodes successfully started
Output
*******
@@ -48,9 +48,3 @@ Output
<tr><td>z</td> <td> </td> <td>integer</td> <td>Z position of the node</td> </tr>
</table>
Sample session
***************
.. literalinclude:: ../../../examples/controller_post_projectsprojectidnodesstart.txt
docs/api/v2/controller/node/projectsprojectidnodesstop.rst
+1 -7
View File
@@ -13,9 +13,9 @@ Parameters
Response status codes
**********************
- **204**: All nodes successfully stopped
- **400**: Invalid request
- **404**: Instance doesn't exist
- **204**: All nodes successfully stopped
Output
*******
@@ -48,9 +48,3 @@ Output
<tr><td>z</td> <td> </td> <td>integer</td> <td>Z position of the node</td> </tr>
</table>
Sample session
***************
.. literalinclude:: ../../../examples/controller_post_projectsprojectidnodesstop.txt
docs/api/v2/controller/node/projectsprojectidnodessuspend.rst
+1 -7
View File
@@ -13,9 +13,9 @@ Parameters
Response status codes
**********************
- **204**: All nodes successfully suspended
- **400**: Invalid request
- **404**: Instance doesn't exist
- **204**: All nodes successfully suspended
Output
*******
@@ -48,9 +48,3 @@ Output
<tr><td>z</td> <td> </td> <td>integer</td> <td>Z position of the node</td> </tr>
</table>
Sample session
***************
.. literalinclude:: ../../../examples/controller_post_projectsprojectidnodessuspend.txt