[incubator-ponymail] branch master updated: Bug: notifications.lua 'seen' option is not documented

[se...@apache.org]

This is an automated email from the ASF dual-hosted git repository.

sebb pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/incubator-ponymail.git


The following commit(s) were added to refs/heads/master by this push:
     new 94876d8  Bug: notifications.lua 'seen' option is not documented
94876d8 is described below

commit 94876d8532e86c18b7307e48e913c00a8525e2b7
Author: Sebb <se...@apache.org>
AuthorDate: Tue Jun 15 21:04:55 2021 +0100

    Bug: notifications.lua 'seen' option is not documented
    
    This fixes #539
---
 CHANGELOG.md | 1 +
 docs/API.md  | 7 +++++--
 2 files changed, 6 insertions(+), 2 deletions(-)

diff --git a/CHANGELOG.md b/CHANGELOG.md
index 8248ba5..6412042 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -1,4 +1,5 @@
 ## Changes in 0.12:
+- Bug: notifications.lua 'seen' option is not documented (#539)
 - Bug: &since option for stats.lua is not documented (#537)
 - Bug: PM setup does not support ES 6 - undocumented (#536)
 - Bug: buffering=1 not allowed with binary files (#534)
diff --git a/docs/API.md b/docs/API.md
index 64f4a5c..7823bec 100644
--- a/docs/API.md
+++ b/docs/API.md
@@ -202,9 +202,10 @@ Response example:
 
 ### Fetching notifications for a logged in user
 Usage:
-`GET /api/notifications.lua`
+`GET /api/notifications.lua[?seen=$mid]`
 
-Parameters: `None` (cookie required)
+Parameters: (cookie required)
+  - $mid: id of the message to be marked as having been seen
 
 
 Response example:
@@ -213,6 +214,8 @@ Response example:
 {
     "notifications": {...}
 }
+or
+{"marked": true}
 ~~~
 
 ### Fetching a month's data as an mbox file