Add documentation

This commit is contained in:
Julien Duponchelle committed 2016-06-29 15:17:02 +02:00
1 parent 22f9effede
commit d8317e8128
9 files changed
+391

No files matched your search

@@ -0,0 +1,34 @@
/v2/settings
------------------------------------------------------------------------------------------------------------------------------------------
.. contents::
GET /v2/settings
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Retrieve gui settings from the server. Temporary will we removed in later release
Response status codes
**********************
- **200**: OK
Sample session
***************
.. literalinclude:: ../../../examples/controller_get_settings.txt
POST /v2/settings
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Write gui settings on the server. Temporary will we removed in later releas
Response status codes
**********************
- **201**: Writed
Sample session
***************
.. literalinclude:: ../../../examples/controller_post_settings.txt
+8
View File
@@ -0,0 +1,8 @@
Symbol
-----------------------------
.. toctree::
:glob:
:maxdepth: 2
symbol/*
+19
View File
@@ -0,0 +1,19 @@
/v2/symbols
------------------------------------------------------------------------------------------------------------------------------------------
.. contents::
GET /v2/symbols
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
List of symbols
Response status codes
**********************
- **200**: Symbols list returned
Sample session
***************
.. literalinclude:: ../../../examples/controller_get_symbols.txt
@@ -0,0 +1,22 @@
/v2/symbols/{symbol_id:.+}/raw
------------------------------------------------------------------------------------------------------------------------------------------
.. contents::
GET /v2/symbols/**{symbol_id:.+}**/raw
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Get the symbol file
Response status codes
**********************
- **200**: Symbol returned
POST /v2/symbols/**{symbol_id:.+}**/raw
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Write the symbol file
Response status codes
**********************
- **200**: Symbol returned