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/controller/project/projects.rst
-2
View File
@@ -21,7 +21,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
@@ -33,7 +32,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/controller/project/projectsprojectid.rst
+4 -4
View File
@@ -5,15 +5,15 @@
GET /v2/projects/**{project_id}**
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Get the project
Get a project
Parameters
**********
- **project_id**: The UUID of the project
- **project_id**: Project UUID
Response status codes
**********************
- **200**: The project exist
- **200**: Project information returned
- **404**: The project doesn't exist
Sample session
@@ -29,7 +29,7 @@ Delete a project from disk
Parameters
**********
- **project_id**: The UUID of the project
- **project_id**: Project UUID
Response status codes
**********************
docs/api/v2/controller/project/projectsprojectidclose.rst
+1 -1
View File
@@ -9,7 +9,7 @@ Close a project
Parameters
**********
- **project_id**: The UUID of the project
- **project_id**: Project UUID
Response status codes
**********************
docs/api/v2/controller/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/controller/project/projectsprojectidnotifications.rst
+2 -2
View File
@@ -5,11 +5,11 @@
GET /v2/projects/**{project_id}**/notifications
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Receive notifications about the projects
Receive notifications about projects
Parameters
**********
- **project_id**: The UUID of the project
- **project_id**: Project UUID
Response status codes
**********************
docs/api/v2/controller/project/projectsprojectidnotificationsws.rst
+2 -2
View File
@@ -5,11 +5,11 @@
GET /v2/projects/**{project_id}**/notifications/ws
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Receive notifications about the projects via Websocket
Receive notifications about projects from a Websocket
Parameters
**********
- **project_id**: The UUID of the project
- **project_id**: Project UUID
Response status codes
**********************