Commit graph

22 commits

Author SHA1 Message Date
Gina Häußge
157408b53a Back ported some documentation from devel 2015-03-23 10:08:16 +01:00
Gina Häußge
ad68b05f7d Fix: docs for printer resource now match implementation 2015-03-09 09:29:17 +01:00
Gina Häußge
590d2f2661 Added docs-specific requirements.txt for the docs to build on readthedocs.org 2014-08-31 21:40:03 +02:00
Gina Häußge
9b3569be50 Added release notes for 1.1.0 and documentation of OctoPrint's events and the version resource 2014-08-31 15:17:32 +02:00
Gina Häußge
017654852d We want the year in the docs to always be current
(cherry picked from commit f7f7d5c)
2014-08-08 17:14:50 +02:00
Gina Häußge
9e2e616e1b Let's see if fetching the version from the octoprint module works on rtd...
(cherry picked from commit 85fc2b2)
2014-08-08 17:14:46 +02:00
Gina Häußge
ace102e1c1 Added API documentation, adjusted API and returned data model slightly to be consistent with other parts of the API, made log file management restricted to admins.
TODO: Make downloading of logs also restricted to admins
2014-02-24 09:57:51 +01:00
Gina Häußge
bd96571d8a Merge pull request #377 from MissionSt/api-doc-fix
Fix urls in connection API examples
2014-02-15 09:36:26 +01:00
Gabe Rosenhouse
b8a59097c2 correct response code for connection success 2014-02-14 22:51:27 -08:00
Gabe Rosenhouse
3f7b222b92 fix up urls in API example requests 2014-02-14 11:33:53 -08:00
Gina Häußge
adea84e123 Teenytiny update to the API docs to indicate current state of temperature APIs (hint: still highly unstable and heavily being worked on conceptually) 2014-01-09 21:14:25 +01:00
Gina Häußge
cec2bdb805 Send completion percentage as float (incl. available decimals) 2013-12-25 23:39:51 +01:00
Gina Häußge
538338abfe More work on the API + documentation
Changed some endpoints again (removed "/control" path element) and made API spit out only raw data (e.g. seconds, millimeters, unix timestamps etc) instead of formatted versions. Modified frontend to take care of formatting this data itself.
2013-12-22 02:01:48 +01:00
Gina Häußge
eccc9d6fbd WARNING: A lot of changes to the existing API and the event system.
This WILL break existing API clients and probably some event handlers too. I'm sorry for the disruptive changes, but I needed to rectify some decisions before they went too far utilized elsewhere to still be corrected.

 Basically this change completely removes the old API and switches it (same endpoint) with the new one, that's basically the existing AJAX API that the client uses, but way more RESTful and based on JSON (exception being the file upload).

 The event system has been revamped to carry more payload data (and in an extensible form as dictionary, to allow for later addition of attributes to single events), with the existing event listeners adjusted to also allow users to make use of this data in their consumers.

 Documentation has been greatly enhanced for the REST API (and is still being added to), the events will be documented here as well.
2013-12-21 14:46:20 +01:00
Gina Häußge
b6cdc5803b More documentation 2013-12-21 13:01:18 +01:00
Gina Häußge
792299537d Some more documentation 2013-12-16 02:11:40 +01:00
Gina Häußge
7b01e72a9b Deleting a file of course work via DELETE, not POST 2013-12-16 01:49:17 +01:00
Gina Häußge
755549a745 Some further API documentation 2013-12-16 01:47:06 +01:00
Gina Häußge
1c39555255 Added a very small intro to the docs 2013-12-15 18:56:16 +01:00
Gina Häußge
ff5aba9a51 Forgot to commit images 2013-12-15 18:52:05 +01:00
Gina Häußge
09bed4e74f Started documenting OctoPrint's REST API 2013-12-15 18:45:38 +01:00
Gina Häußge
ac75ee9831 Starting documentation based on Sphinx 2013-12-02 17:40:31 +01:00