| Internet-Draft | JMAP REST | April 2023 |
| Baum & Happel | Expires 8 October 2023 | [Page] |
This document specifies a REST Mapping for JMAP endpoints to impose fewer requirements on applications compared to conventional JMAP endpoints.¶
This Internet-Draft is submitted in full conformance with the provisions of BCP 78 and BCP 79.¶
Internet-Drafts are working documents of the Internet Engineering Task Force (IETF). Note that other groups may also distribute working documents as Internet-Drafts. The list of current Internet-Drafts is at https://datatracker.ietf.org/drafts/current/.¶
Internet-Drafts are draft documents valid for a maximum of six months and may be updated, replaced, or obsoleted by other documents at any time. It is inappropriate to use Internet-Drafts as reference material or to cite them other than as "work in progress."¶
This Internet-Draft will expire on 8 October 2023.¶
Copyright (c) 2023 IETF Trust and the persons identified as the document authors. All rights reserved.¶
This document is subject to BCP 78 and the IETF Trust's Legal Provisions Relating to IETF Documents (https://trustee.ietf.org/license-info) in effect on the date of publication of this document. Please review these documents carefully, as they describe your rights and restrictions with respect to this document. Code Components extracted from this document must include Revised BSD License text as described in Section 4.e of the Trust Legal Provisions and are provided without warranty as described in the Revised BSD License.¶
Structured data exchange over JMAP [RFC8620] usually involves processing JMAP Request JSON payloads. This might impose unnecessary requirements for certain use cases of JMAP. Likely scenarios in which this is beneficiary are situations in which portability needs to be provided due to regulatory requirements or when migrating user data away from legacy platforms.¶
For rapid development of a JMAP API without support for batching, the essential properties of the Request object can instead be implemented as a URI.¶
The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", "SHOULD", "SHOULD NOT", "RECOMMENDED", "NOT RECOMMENDED", "MAY", and "OPTIONAL" in this document are to be interpreted as described in BCP 14 [RFC2119] [RFC8174] when, and only when, they appear in all capitals, as shown here.¶
The definitions of JSON keys and datatypes in the document follow the conventions described in the core JMAP specification [RFC8620].¶
The capabilities object is returned as part of the JMAP Session object; see [RFC8620], Section 2. This document defines one additional capability URI.¶
The capability urn:ietf:params:jmap:rest being present in the "capabilities" property represents support for the simplified JMAP REST API.¶
The value of this property in the JMAP Session capabilities property and the account's accountCapabilities property is an empty object.¶
The JMAP Session Resource will be extended by the following property:¶
String The URL to use for JMAP API requests. THE URL MUST
contain the variables using and methodCall as defined in [RFC8620] Section 3.3. One MAY use additional variables specific to a JMAP method like ids or accountId. Implementations MAY implement the required variables as query parameters to avoid implementing routing logic.¶
{
...
"capabilities": {
...,
"urn:ietf:params:jmap:rest": {}
},
"apiUrlRest": "https://jmap.me/api
/?accountId=<account-id>&methodCall=<methodCall>&ids=<ids>"
}
¶
All security considerations of JMAP [RFC8620] apply to this specification.¶
IANA is requested to register the "rest" JMAP Capability as follows:¶
Capability Name: urn:ietf:params:jmap:rest¶
Specification document: this document¶
Intended use: common¶
Change Controller: IETF¶
Security and privacy considerations: this document, Section 2.¶
Bron Gondwana, Neil Jenkins, Alexey Melnikov, Ken Murchison, Robert Stepanek and the JMAP working group at the IETF.¶