Build doc support controller

This commit is contained in:
Julien Duponchelle committed 2016-03-04 17:50:17 +01:00
1 parent 0921df520c
commit e4b12f49d1
194 files changed
+1259 -724

No files matched your search

+8
View File
@@ -0,0 +1,8 @@
Server
---------------------
.. toctree::
:glob:
:maxdepth: 2
server/*
+48
View File
@@ -0,0 +1,48 @@
/v1/servers
----------------------------------------------------------------------------------------------------------------------
.. contents::
POST /v1/servers
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Register a server
Response status codes
**********************
- **201**: Server added
Input
*******
.. raw:: html
<table>
<tr> <th>Name</th> <th>Mandatory</th> <th>Type</th> <th>Description</th> </tr>
<tr><td>host</td> <td>&#10004;</td> <td>string</td> <td>Server host</td> </tr>
<tr><td>password</td> <td> </td> <td>string</td> <td>Password for auth</td> </tr>
<tr><td>port</td> <td>&#10004;</td> <td>integer</td> <td>Server port</td> </tr>
<tr><td>protocol</td> <td>&#10004;</td> <td>enum</td> <td>Possible values: http, https</td> </tr>
<tr><td>server_id</td> <td>&#10004;</td> <td>string</td> <td>Server identifier</td> </tr>
<tr><td>user</td> <td> </td> <td>string</td> <td>User for auth</td> </tr>
</table>
Output
*******
.. raw:: html
<table>
<tr> <th>Name</th> <th>Mandatory</th> <th>Type</th> <th>Description</th> </tr>
<tr><td>connected</td> <td> </td> <td>boolean</td> <td>True if controller is connected to the server</td> </tr>
<tr><td>host</td> <td>&#10004;</td> <td>string</td> <td>Server host</td> </tr>
<tr><td>port</td> <td>&#10004;</td> <td>integer</td> <td>Server port</td> </tr>
<tr><td>protocol</td> <td>&#10004;</td> <td>enum</td> <td>Possible values: http, https</td> </tr>
<tr><td>server_id</td> <td>&#10004;</td> <td>string</td> <td>Server identifier</td> </tr>
<tr><td>user</td> <td> </td> <td>string</td> <td>User for auth</td> </tr>
<tr><td>version</td> <td> </td> <td>['string', 'null']</td> <td>Version of the GNS3 remote server</td> </tr>
</table>
Sample session
***************
.. literalinclude:: ../../../examples/post_servers.txt