summaryrefslogtreecommitdiff
path: root/doc/api
diff options
context:
space:
mode:
authorLuc Didry <luc@didry.org>2015-02-24 23:42:35 +0100
committerLuc Didry <luc@didry.org>2015-02-24 23:42:35 +0100
commita08c50a77dc897009f9e40d9d0bdab0a219d59fa (patch)
tree01ef54b082de8f35bfcc420af59c4f4ff736caed /doc/api
parent768b012e8b7aa8b71ac47354793d02e2a5b3a057 (diff)
downloadetherpad-lite-a08c50a77dc897009f9e40d9d0bdab0a219d59fa.zip
Fixes #1870
Add two functions to API : * getSavedRevisionsCount * listSavedRevisions
Diffstat (limited to 'doc/api')
-rw-r--r--doc/api/http_api.md20
1 files changed, 19 insertions, 1 deletions
diff --git a/doc/api/http_api.md b/doc/api/http_api.md
index 84a4ec7e..d6432e3c 100644
--- a/doc/api/http_api.md
+++ b/doc/api/http_api.md
@@ -61,7 +61,7 @@ Portal submits content into new blog post
## Usage
### API version
-The latest version is `1.2.10`
+The latest version is `1.2.11`
The current version can be queried via /api.
@@ -402,6 +402,24 @@ returns the number of revisions of this pad
* `{code: 0, message:"ok", data: {revisions: 56}}`
* `{code: 1, message:"padID does not exist", data: null}`
+#### getSavedRevisionsCount(padID)
+ * API >= 1.2.11
+
+returns the number of saved revisions of this pad
+
+*Example returns:*
+ * `{code: 0, message:"ok", data: {savedRevisions: 42}}`
+ * `{code: 1, message:"padID does not exist", data: null}`
+
+#### listSavedRevisions(padID)
+ * API >= 1.2.11
+
+returns the list of saved revisions of this pad
+
+*Example returns:*
+ * `{code: 0, message:"ok", data: {savedRevisions: [2, 42, 1337]}}`
+ * `{code: 1, message:"padID does not exist", data: null}`
+
#### padUsersCount(padID)
* API >= 1