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 d8378ee Bug: atom.lua is not documented
d8378ee is described below
commit d8378eedad61dc9f52e41519172ab01c838441fa
Author: Sebb <[email protected]>
AuthorDate: Tue Jun 15 21:39:04 2021 +0100
Bug: atom.lua is not documented
This fixes #538
---
CHANGELOG.md | 1 +
docs/API.md | 18 ++++++++++++++++++
2 files changed, 19 insertions(+)
diff --git a/CHANGELOG.md b/CHANGELOG.md
index 6412042..1b758b7 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -1,4 +1,5 @@
## Changes in 0.12:
+- Bug: atom.lua is not documented (#538)
- 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)
diff --git a/docs/API.md b/docs/API.md
index 7823bec..d94ece3 100644
--- a/docs/API.md
+++ b/docs/API.md
@@ -228,3 +228,21 @@ Response example:
TBA
~~~
+### Get ATOM data for list or email
+
+Usage:
+`GET /api/atom/lua(?list=$lid|?mid=$mid)`
+
+Parameters: (cookie may be required)
+ - $lid: the list id, e.g. [email protected]
+ - $mid: The email ID (Permalink)
+
+One of the above is required.
+In the case of the list id, data is returned for the last month.
+For email ID, the thread is returned.
+
+Response example:
+
+~~~
+TBA
+~~~
