mirror of
https://github.com/GNS3/gns3-server.git
synced 2026-11-03 05:51:15 +02:00
Update API documentation
This commit is contained in:
1 parent
21a7a68875
commit
e6d2bd4424
360 files changed
+17598
-896
No files matched your search
@@ -37,6 +37,12 @@ Output
|
||||
<tr><td>snapshot_id</td> <td>✔</td> <td>string</td> <td>Snapshot UUID</td> </tr>
|
||||
</table>
|
||||
|
||||
Sample session
|
||||
***************
|
||||
|
||||
|
||||
.. literalinclude:: ../../../examples/controller_post_projectsprojectidsnapshots.txt
|
||||
|
||||
|
||||
GET /v2/projects/**{project_id}**/snapshots
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
@@ -51,3 +57,9 @@ Response status codes
|
||||
- **200**: Snasphot list returned
|
||||
- **404**: The project doesn't exist
|
||||
|
||||
Sample session
|
||||
***************
|
||||
|
||||
|
||||
.. literalinclude:: ../../../examples/controller_get_projectsprojectidsnapshots.txt
|
||||
|
||||
@@ -9,11 +9,17 @@ Delete a snapshot from disk
|
||||
|
||||
Parameters
|
||||
**********
|
||||
- **snapshot_id**: Snasphot UUID
|
||||
- **project_id**: Project UUID
|
||||
- **snapshot_id**: Snasphot UUID
|
||||
|
||||
Response status codes
|
||||
**********************
|
||||
- **404**: The project or snapshot doesn't exist
|
||||
- **204**: Changes have been written on disk
|
||||
- **404**: The project or snapshot doesn't exist
|
||||
|
||||
Sample session
|
||||
***************
|
||||
|
||||
|
||||
.. literalinclude:: ../../../examples/controller_delete_projectsprojectidsnapshotssnapshotid.txt
|
||||
|
||||
@@ -9,8 +9,8 @@ Restore a snapshot from disk
|
||||
|
||||
Parameters
|
||||
**********
|
||||
- **snapshot_id**: Snasphot UUID
|
||||
- **project_id**: Project UUID
|
||||
- **snapshot_id**: Snasphot UUID
|
||||
|
||||
Response status codes
|
||||
**********************
|
||||
@@ -40,3 +40,9 @@ Output
|
||||
<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
|
||||
|
||||
Reference in new issue
Block a user