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