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

Update docs

Browse Source
This commit is contained in:
Julien Duponchelle committed 2016-06-06 14:24:13 +02:00
1 parent 65bfb4b907
commit e80dd40121
264 files changed
+3544 -1582
Download Patch File Download Diff File Expand all files Collapse all files

No files matched your search

docs/api/v2/compute/project/projects.rst
+2 -4
View File
@@ -5,7 +5,7 @@
GET /v2/compute/projects
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
List projects opened on the server
List all projects opened on the server
Response status codes
**********************
@@ -25,7 +25,7 @@ Create a new project on the server
Response status codes
**********************
- **201**: Project created
- **403**: You are not allowed to modify this property
- **403**: Forbidden to create a project
- **409**: Project already created
Input
@@ -37,7 +37,6 @@ Input
<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
@@ -49,7 +48,6 @@ Output
<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
docs/api/v2/compute/project/projectsprojectid.rst
+5 -8
View File
@@ -9,7 +9,7 @@ Get project information
Parameters
**********
- **project_id**: The UUID of the project
- **project_id**: Project UUID
Response status codes
**********************
@@ -25,7 +25,6 @@ Output
<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
@@ -41,12 +40,12 @@ Update a project
Parameters
**********
- **project_id**: The UUID of the project
- **project_id**: Project UUID
Response status codes
**********************
- **200**: The project has been updated
- **403**: You are not allowed to modify this property
- **200**: Project updated
- **403**: Forbidden to update this project
- **404**: The project doesn't exist
Input
@@ -57,7 +56,6 @@ Input
<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>Path of the project on the server (work only with --local)</td> </tr>
<tr><td>temporary</td> <td> </td> <td>boolean</td> <td>If project is a temporary project</td> </tr>
</table>
Output
@@ -69,7 +67,6 @@ Output
<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
@@ -85,7 +82,7 @@ Delete a project from disk
Parameters
**********
- **project_id**: The UUID of the project
- **project_id**: Project UUID
Response status codes
**********************
docs/api/v2/compute/project/projectsprojectidclose.rst
+2 -2
View File
@@ -9,12 +9,12 @@ Close a project
Parameters
**********
- **project_id**: The UUID of the project
- **project_id**: Project UUID
Response status codes
**********************
- **404**: The project doesn't exist
- **204**: The project has been closed
- **204**: Project closed
Sample session
***************
docs/api/v2/compute/project/projectsprojectidcommit.rst
+1 -1
View File
@@ -9,7 +9,7 @@ Write changes on disk
Parameters
**********
- **project_id**: The UUID of the project
- **project_id**: Project UUID
Response status codes
**********************
docs/api/v2/compute/project/projectsprojectidexport.rst
+2 -2
View File
@@ -9,10 +9,10 @@ Export a project as a portable archive
Parameters
**********
- **project_id**: The UUID of the project
- **project_id**: Project UUID
Response status codes
**********************
- **200**: Return the file
- **200**: File returned
- **404**: The project doesn't exist
docs/api/v2/compute/project/projectsprojectidfiles.rst
+2 -2
View File
@@ -9,10 +9,10 @@ List files of a project
Parameters
**********
- **project_id**: The UUID of the project
- **project_id**: Project UUID
Response status codes
**********************
- **200**: Return list of files
- **200**: Return a list of files
- **404**: The project doesn't exist
docs/api/v2/compute/project/projectsprojectidfilespath.rst
+6 -6
View File
@@ -5,30 +5,30 @@
GET /v2/compute/projects/**{project_id}**/files/**{path:.+}**
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Get a file of a project
Get a file from a project
Parameters
**********
- **project_id**: The UUID of the project
- **project_id**: Project UUID
Response status codes
**********************
- **200**: Return the file
- **200**: File returned
- **403**: Permission denied
- **404**: The file doesn't exist
POST /v2/compute/projects/**{project_id}**/files/**{path:.+}**
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Get a file of a project
Write a file to a project
Parameters
**********
- **project_id**: The UUID of the project
- **project_id**: Project UUID
Response status codes
**********************
- **200**: Return the file
- **200**: File returned
- **403**: Permission denied
- **404**: The path doesn't exist
docs/api/v2/compute/project/projectsprojectidimport.rst
+2 -3
View File
@@ -9,12 +9,12 @@ Import a project from a portable archive
Parameters
**********
- **project_id**: The UUID of the project
- **project_id**: Project UUID
Response status codes
**********************
- **200**: Project imported
- **403**: You are not allowed to modify this property
- **403**: Forbidden to import project
Output
*******
@@ -25,6 +25,5 @@ Output
<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>
docs/api/v2/compute/project/projectsprojectidnotifications.rst
+2 -2
View File
@@ -5,11 +5,11 @@
GET /v2/compute/projects/**{project_id}**/notifications
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Receive notifications about the projects
Receive notifications about the project
Parameters
**********
- **project_id**: The UUID of the project
- **project_id**: Project UUID
Response status codes
**********************
docs/api/v2/compute/project/projectsprojectidstreampath.rst
+2 -2
View File
@@ -9,11 +9,11 @@ Stream a file from a project
Parameters
**********
- **project_id**: The UUID of the project
- **project_id**: Project UUID
Response status codes
**********************
- **200**: Return the file
- **200**: File returned
- **403**: Permission denied
- **404**: The file doesn't exist