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 API documentation. Fixes #1253.

Browse Source
This commit is contained in:
grossmj committed 2018-01-08 11:57:07 +07:00
1 parent e8353e68bb
commit ffe21f6b73
324 files changed
+1168 -14199
Download Patch File Download Diff File Expand all files Collapse all files

No files matched your search

docs/api/v2/controller/snapshot/projectsprojectidsnapshots.rst
-12
View File
@@ -37,12 +37,6 @@ Output
<tr><td>snapshot_id</td> <td>&#10004;</td> <td>string</td> <td>Snapshot UUID</td> </tr>
</table>
Sample session
***************
.. literalinclude:: ../../../examples/controller_post_projectsprojectidsnapshots.txt
GET /v2/projects/**{project_id}**/snapshots
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -57,9 +51,3 @@ Response status codes
- **200**: Snasphot list returned
- **404**: The project doesn't exist
Sample session
***************
.. literalinclude:: ../../../examples/controller_get_projectsprojectidsnapshots.txt
docs/api/v2/controller/snapshot/projectsprojectidsnapshotssnapshotid.rst
+2 -8
View File
@@ -9,17 +9,11 @@ Delete a snapshot from disk
Parameters
**********
- **project_id**: Project UUID
- **snapshot_id**: Snasphot UUID
- **project_id**: Project UUID
Response status codes
**********************
- **204**: Changes have been written on disk
- **404**: The project or snapshot doesn't exist
Sample session
***************
.. literalinclude:: ../../../examples/controller_delete_projectsprojectidsnapshotssnapshotid.txt
- **204**: Changes have been written on disk
docs/api/v2/controller/snapshot/projectsprojectidsnapshotssnapshotidrestore.rst
+6 -7
View File
@@ -9,8 +9,8 @@ Restore a snapshot from disk
Parameters
**********
- **project_id**: Project UUID
- **snapshot_id**: Snasphot UUID
- **project_id**: Project UUID
Response status codes
**********************
@@ -32,12 +32,11 @@ Output
<tr><td>project_id</td> <td>&#10004;</td> <td>string</td> <td>Project UUID</td> </tr>
<tr><td>scene_height</td> <td> </td> <td>integer</td> <td>Height of the drawing area</td> </tr>
<tr><td>scene_width</td> <td> </td> <td>integer</td> <td>Width of the drawing area</td> </tr>
<tr><td>show_grid</td> <td> </td> <td>boolean</td> <td>Show the grid on the drawing area</td> </tr>
<tr><td>show_interface_labels</td> <td> </td> <td>boolean</td> <td>Show interface labels on the drawing area</td> </tr>
<tr><td>show_layers</td> <td> </td> <td>boolean</td> <td>Show layers on the drawing area</td> </tr>
<tr><td>snap_to_grid</td> <td> </td> <td>boolean</td> <td>Snap to grid on the drawing area</td> </tr>
<tr><td>status</td> <td> </td> <td>enum</td> <td>Possible values: opened, closed</td> </tr>
<tr><td>zoom</td> <td> </td> <td>integer</td> <td>Zoom of the drawing area</td> </tr>
</table>
Sample session
***************
.. literalinclude:: ../../../examples/controller_post_projectsprojectidsnapshotssnapshotidrestore.txt