Docs: Document /export API endpoint

2020-05-13 23:22:57 +02:00 · 2020-05-13 23:22:57 +02:00 · fdbe69ebc8
parent bd5b4f5940
commit fdbe69ebc8
1 changed files with 28 additions and 0 deletions
--- a/docs/bookmark.rst
+++ b/docs/bookmark.rst
@ -281,3 +281,31 @@ Get a favicon
      Content-Type: image/png

      ... binary data ...
+
+Export all bookmarks
+====================
+
+.. get:: /public/rest/v2/bookmark/export
+
+   :synopsis: Export all bookmarks of the current user in a HTML file.
+
+   .. versionadded:: 0.11.0
+
+   **Example:**
+
+   .. sourcecode:: http
+
+      GET /index.php/apps/bookmarks/public/rest/v2/bookmark/export HTTP/1.1
+      Host: example.com
+
+
+   **Response:**
+
+   .. sourcecode:: http
+
+      HTTP/1.1 200 OK
+      Content-Type: text/html
+
+      <html>
+      ...
+