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

Documentation

Browse Source
This commit is contained in:
Julien Duponchelle committed 2016-03-11 15:21:21 +01:00
1 parent be4aa41dda
commit 7d0b780dcc
135 files changed
+623 -295
Download Patch File Download Diff File Expand all files Collapse all files

No files matched your search

docs/api/v2/controller/project/projects.rst
+44
View File
@@ -0,0 +1,44 @@
/v2/controller/projects
------------------------------------------------------------------------------------------------------------------------------------------
.. contents::
POST /v2/controller/projects
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Create a new project on the server
Response status codes
**********************
- **201**: Project created
- **409**: Project already created
Input
*******
.. raw:: html
<table>
<tr> <th>Name</th> <th>Mandatory</th> <th>Type</th> <th>Description</th> </tr>
<tr><td>name</td> <td> </td> <td>['string', 'null']</td> <td>Project name</td> </tr>
<tr><td>path</td> <td> </td> <td>['string', 'null']</td> <td>Project directory</td> </tr>
<tr><td>project_id</td> <td> </td> <td>['string', 'null']</td> <td>Project UUID</td> </tr>
<tr><td>temporary</td> <td> </td> <td>boolean</td> <td>If project is a temporary project</td> </tr>
</table>
Output
*******
.. raw:: html
<table>
<tr> <th>Name</th> <th>Mandatory</th> <th>Type</th> <th>Description</th> </tr>
<tr><td>name</td> <td> </td> <td>['string', 'null']</td> <td>Project name</td> </tr>
<tr><td>path</td> <td> </td> <td>['string', 'null']</td> <td>Project directory</td> </tr>
<tr><td>project_id</td> <td>&#10004;</td> <td>string</td> <td>Project UUID</td> </tr>
<tr><td>temporary</td> <td>&#10004;</td> <td>boolean</td> <td>If project is a temporary project</td> </tr>
</table>
Sample session
***************
.. literalinclude:: ../../../examples/controller_post_projects.txt
docs/api/v2/controller/project/projectsprojectid.rst
+24
View File
@@ -0,0 +1,24 @@
/v2/controller/projects/{project_id}
------------------------------------------------------------------------------------------------------------------------------------------
.. contents::
DELETE /v2/controller/projects/**{project_id}**
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Delete a project from disk
Parameters
**********
- **project_id**: The UUID of the project
Response status codes
**********************
- **404**: The project doesn't exist
- **204**: Changes have been written on disk
Sample session
***************
.. literalinclude:: ../../../examples/controller_delete_projectsprojectid.txt
docs/api/v2/controller/project/projectsprojectidclose.rst
+24
View File
@@ -0,0 +1,24 @@
/v2/controller/projects/{project_id}/close
------------------------------------------------------------------------------------------------------------------------------------------
.. contents::
POST /v2/controller/projects/**{project_id}**/close
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Close a project
Parameters
**********
- **project_id**: The UUID of the project
Response status codes
**********************
- **404**: The project doesn't exist
- **204**: The project has been closed
Sample session
***************
.. literalinclude:: ../../../examples/controller_post_projectsprojectidclose.txt
docs/api/v2/controller/project/projectsprojectidcommit.rst
+24
View File
@@ -0,0 +1,24 @@
/v2/controller/projects/{project_id}/commit
------------------------------------------------------------------------------------------------------------------------------------------
.. contents::
POST /v2/controller/projects/**{project_id}**/commit
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Write changes on disk
Parameters
**********
- **project_id**: The UUID of the project
Response status codes
**********************
- **404**: The project doesn't exist
- **204**: Changes have been written on disk
Sample session
***************
.. literalinclude:: ../../../examples/controller_post_projectsprojectidcommit.txt