ExternalVendorCode/gns3-server
1
0
Fork 0
mirror of https://github.com/GNS3/gns3-server.git synced 2025-06-22 16:59:02 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Fix documentation generation

Browse Source
This commit is contained in:
Julien Duponchelle
2015-01-20 15:21:13 +01:00
parent 0b97509a74
commit f5ac73d1ca
11 changed files with 197 additions and 225 deletions
Download Patch File Download Diff File Expand all files Collapse all files

39
docs/api/project.rst Normal file
View File

@ -0,0 +1,39 @@
/project
---------------------------------------------
.. contents::
POST /project
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Create a project on the server
Response status codes
**********************
- **200**: OK
Input
*******
.. raw:: html
<table>
<tr> <th>Name</th> <th>Mandatory</th> <th>Type</th> <th>Description</th> </tr>
<tr><td>location</td> <td> </td> <td>string</td> <td>Base directory where the project should be created on remote server</td> </tr>
<tr><td>uuid</td> <td> </td> <td>string</td> <td>Project UUID</td> </tr>
</table>
Output
*******
.. raw:: html
<table>
<tr> <th>Name</th> <th>Mandatory</th> <th>Type</th> <th>Description</th> </tr>
<tr><td>location</td> <td> </td> <td>string</td> <td>Base directory where the project should be created on remote server</td> </tr>
<tr><td>uuid</td> <td> </td> <td>string</td> <td>Project UUID</td> </tr>
</table>
Sample session
***************
.. literalinclude:: examples/post_project.txt