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/drawing/projectsprojectiddrawings.rst
+1 -13
View File
@@ -15,12 +15,6 @@ Response status codes
**********************
- **200**: List of drawings returned
Sample session
***************
.. literalinclude:: ../../../examples/controller_get_projectsprojectiddrawings.txt
POST /v2/projects/**{project_id}**/drawings
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -32,8 +26,8 @@ Parameters
Response status codes
**********************
- **201**: Drawing created
- **400**: Invalid request
- **201**: Drawing created
Input
*******
@@ -65,9 +59,3 @@ Output
<tr><td>z</td> <td> </td> <td>integer</td> <td>Z property</td> </tr>
</table>
Sample session
***************
.. literalinclude:: ../../../examples/controller_post_projectsprojectiddrawings.txt
docs/api/v2/controller/drawing/projectsprojectiddrawingsdrawingid.rst
+4 -16
View File
@@ -9,13 +9,13 @@ Create a new drawing instance
Parameters
**********
- **project_id**: Project UUID
- **drawing_id**: Drawing UUID
- **project_id**: Project UUID
Response status codes
**********************
- **201**: Drawing updated
- **400**: Invalid request
- **201**: Drawing updated
Input
*******
@@ -47,12 +47,6 @@ Output
<tr><td>z</td> <td> </td> <td>integer</td> <td>Z property</td> </tr>
</table>
Sample session
***************
.. literalinclude:: ../../../examples/controller_put_projectsprojectiddrawingsdrawingid.txt
DELETE /v2/projects/**{project_id}**/drawings/**{drawing_id}**
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -60,17 +54,11 @@ Delete a drawing instance
Parameters
**********
- **project_id**: Project UUID
- **drawing_id**: Drawing UUID
- **project_id**: Project UUID
Response status codes
**********************
- **204**: Drawing deleted
- **400**: Invalid request
Sample session
***************
.. literalinclude:: ../../../examples/controller_delete_projectsprojectiddrawingsdrawingid.txt
- **204**: Drawing deleted