diff options
| author | Gina Häußge <gina@octoprint.org> | 2022-01-27 17:19:55 +0300 |
|---|---|---|
| committer | Gina Häußge <gina@octoprint.org> | 2022-01-27 17:19:55 +0300 |
| commit | 988fbb52db95ea21c14461f44883898ad2dd3acc (patch) | |
| tree | 0cda879050bf8579842418a7ce9e5f70e13a9a60 /docs | |
| parent | 8be58b105e058b6136cb0703c3b370c394d2bbb7 (diff) | |
| parent | a953938c45f845fb9de14295dab6fde51bf713b7 (diff) | |
Merge branch 'maintenance' of github.com:OctoPrint/OctoPrint into maintenance
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/api/timelapse.rst | 31 |
1 files changed, 28 insertions, 3 deletions
diff --git a/docs/api/timelapse.rst b/docs/api/timelapse.rst index 66e0bb72e..ebe291e83 100644 --- a/docs/api/timelapse.rst +++ b/docs/api/timelapse.rst @@ -27,12 +27,17 @@ Retrieve a list of timelapses and the current config Delete a timelapse ================== -.. http:delete:: /api/timelapse/(string:filename) +.. http:delete:: /api/timelapse/(string:name) - Delete the timelapse ``filename``. + Delete the timelapse ``name``. + + Returns a :ref:`timelapse list <sec-api-timelapse-datamodel-list>` in the + response body with the updated information. Requires the ``TIMELAPSE_DELETE`` permission. + :param unrendered: If provided and true, also include unrendered timelapses in the response + .. _sec-api-timelapse-render: Issue a command for an unrendered timelapse @@ -56,8 +61,13 @@ Delete an unrendered timelapse Delete the unrendered timelapse ``name``. + Returns a :ref:`timelapse list <sec-api-timelapse-datamodel-list>` in the + response body. + Requires the ``TIMELAPSE_DELETE`` permission. + :param unrendered: If provided and true, also include unrendered timelapses in the response + .. _sec-api-timelapse-saveconfig: Change current timelapse config @@ -65,12 +75,19 @@ Change current timelapse config .. http:post:: /api/timelapse - Save a new :ref:`timelapse configuration <sec-api-timelapse-datamodel-config>` to use for the next print. + Save a new :ref:`timelapse configuration <sec-api-timelapse-datamodel-config>` to use for the next print. Set the optional ``save`` flag in the + configuration to ``true`` in order to make the new configuration persist accross restarts. The configuration is expected as the request body. + Returns a :ref:`timelapse list <sec-api-timelapse-datamodel-list>` in the + response body. + Requires the ``TIMELAPSE_ADMIN`` permission. + :param unrendered: If provided and true, also include unrendered timelapses in the response + + .. _sec-api-timelapse-datamodel: Data model @@ -135,6 +152,10 @@ Rendered timelapse - 1 - string - URL for downloading the timelapse + * - ``thumbnail`` + - 1 + - string + - URL for downloading a thumbnail of the timelapse (optional) .. _sec-api-timelapse-datamodel-unrendered: @@ -196,6 +217,10 @@ Timelapse configuration - 1 - string - Type of the timelapse, either ``off``, ``zchange`` or ``timed``. + * - ``save`` + - 1 + - bool + - Optional flag to be included when when saving a configuration to make the configuration persist accross restarts Further fields are timelapse type specific, see below for details. |