You are viewing a plain text version of this content. The canonical link for it is here.
Posted to notifications@james.apache.org by bt...@apache.org on 2020/11/30 12:12:33 UTC
[james-project] 07/07: JAMES-2884 Server JMAP documentation should
point to the annotated JMAP specifications
This is an automated email from the ASF dual-hosted git repository.
btellier pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/james-project.git
commit 4f8b75a724aa7142ccb01ac8cd5559e54e50609a
Author: Benoit Tellier <bt...@linagora.com>
AuthorDate: Mon Nov 30 09:17:28 2020 +0700
JAMES-2884 Server JMAP documentation should point to the annotated JMAP specifications
---
.../servers/pages/distributed/configure/jmap.adoc | 19 +++++++++++++++++++
src/site/xdoc/server/config-jmap.xml | 19 +++++++++++++++++++
2 files changed, 38 insertions(+)
diff --git a/docs/modules/servers/pages/distributed/configure/jmap.adoc b/docs/modules/servers/pages/distributed/configure/jmap.adoc
index 6650de7..8c29504 100644
--- a/docs/modules/servers/pages/distributed/configure/jmap.adoc
+++ b/docs/modules/servers/pages/distributed/configure/jmap.adoc
@@ -77,3 +77,22 @@ This token can then be passed as `Bearer` of the `Authorization` header :
curl -H "Authorization: Bearer $token" -XPOST http://127.0.0.1:80/jmap -d '...'
The public key can be referenced as `jwt.publickeypem.url` of the `jmap.properties` configuration file.
+
+== Annotated specification
+
+The [annotated documentation](https://github.com/apache/james-project/tree/master/server/protocols/jmap-rfc-8621/doc/specs/spec)
+presents the limits of the JMAP RFC-8621 implementation part of the Apache James project.
+
+Some methods / types are not yet implemented, some implementations are naive, and the PUSH is not supported yet.
+
+Users are invited to read these limitations before using actively the JMAP RFC-8621 implementation, and should ensure their
+client applications only uses supported operations.
+
+Contributions enhancing support are furthermore welcomed.
+
+The list of tested JMAP clients are:
+
+ - [OpenPaaS](https://open-paas.org/) is actively using the draft version of the JMAP implementation. Migration to
+ RFC-8621 is planned.
+ - Experiments had been run on top of [LTT.RS](https://github.com/iNPUTmice/lttrs-android). Version in the Accept
+ headers needs to be explicitly set to `rfc-8621`. [Read more](https://github.com/linagora/james-project/pull/4089).
\ No newline at end of file
diff --git a/src/site/xdoc/server/config-jmap.xml b/src/site/xdoc/server/config-jmap.xml
index 77c5326..b006481 100644
--- a/src/site/xdoc/server/config-jmap.xml
+++ b/src/site/xdoc/server/config-jmap.xml
@@ -104,6 +104,25 @@
<li><b>JMAP-RFC-8621</b>: <em>Accept: application/json; jmapVersion=rfc-8621</em></li>
</ul>
</subsection>
+
+ <subsection name="Annotated specification">
+ <p>The <a href="https://github.com/apache/james-project/tree/master/server/protocols/jmap-rfc-8621/doc/specs/spec">annotated documentation</a>
+ presents the limits of the JMAP RFC-8621 implementation part of the Apache James project.</p>
+
+ <p>Some methods / types are not yet implemented, some implementations are naive, and the PUSH is not supported yet.</p>
+
+ <p>Users are invited to read these limitations before using actively the JMAP RFC-8621 implementation, and should ensure their
+ client applications only uses supported operations.</p>
+
+ <p>Contributions enhancing support are furthermore welcomed.</p>
+
+ <ul>The list of tested JMAP clients are:
+ <li><a href="https://open-paas.org/">OpenPaaS</a> is actively using the draft version of the JMAP implementation. Migration to
+ RFC-8621 is planned.</li>
+ <li>Experiments had been run on top of <a href="https://github.com/iNPUTmice/lttrs-android">LTT.RS</a>. Version in the Accept
+ headers needs to be explicitly set to `rfc-8621`. <a href="https://github.com/linagora/james-project/pull/4089">Read more</a>.</li>
+ </ul>
+ </subsection>
</section>
</body>
---------------------------------------------------------------------
To unsubscribe, e-mail: notifications-unsubscribe@james.apache.org
For additional commands, e-mail: notifications-help@james.apache.org