[PATCH v8 05/11] schemata: Add documentation for JSON reply format.

diff --git a/b4/aa5a3671f03cb3872653cf7d323fb878ffb3a9 b/b4/aa5a3671f03cb3872653cf7d323fb878ffb3a9
new file mode 100644 (file)
index 0000000..d031111
--- /dev/null
+++ b/b4/aa5a3671f03cb3872653cf7d323fb878ffb3a9
@@ -0,0 +1,104 @@
+Return-Path: <awg@lagos.xvx.ca>\r
+X-Original-To: notmuch@notmuchmail.org\r
+Delivered-To: notmuch@notmuchmail.org\r
+Received: from localhost (localhost [127.0.0.1])\r
+       by olra.theworths.org (Postfix) with ESMTP id 5FD71431FDA\r
+       for <notmuch@notmuchmail.org>; Sun, 18 Mar 2012 09:33:12 -0700 (PDT)\r
+X-Virus-Scanned: Debian amavisd-new at olra.theworths.org\r
+X-Spam-Flag: NO\r
+X-Spam-Score: 0\r
+X-Spam-Level: \r
+X-Spam-Status: No, score=0 tagged_above=-999 required=5 tests=[none]\r
+       autolearn=disabled\r
+Received: from olra.theworths.org ([127.0.0.1])\r
+       by localhost (olra.theworths.org [127.0.0.1]) (amavisd-new, port 10024)\r
+       with ESMTP id cUe9F3YIq00A for <notmuch@notmuchmail.org>;\r
+       Sun, 18 Mar 2012 09:33:11 -0700 (PDT)\r
+Received: from smtp-out-04.shaw.ca (smtp-out-04.shaw.ca [64.59.134.12])\r
+       by olra.theworths.org (Postfix) with ESMTP id 291E9431E62\r
+       for <notmuch@notmuchmail.org>; Sun, 18 Mar 2012 09:33:02 -0700 (PDT)\r
+Received: from lb7f8hsrpno-svcs.dcs.int.inet (HELO pd6ml1no-ssvc.prod.shaw.ca)\r
+       ([10.0.144.222])\r
+       by pd5mo1no-svcs.prod.shaw.ca with ESMTP; 18 Mar 2012 10:33:00 -0600\r
+X-Cloudmark-SP-Filtered: true\r
+X-Cloudmark-SP-Result: v=1.1 cv=Cufqhujp69hR+MhiHu40yK/USb/hlYs0+irVU46A6+k=\r
+       c=1 sm=1\r
+       a=yoWor0WcDrsA:10 a=BLceEmwcHowA:10 a=yQp6g8lIsgqumF79BAsFDg==:17\r
+       a=DgdU8Ar0EezpiEXugsgA:9 a=ys3i4kPKAKdt6LCgFAAA:7\r
+       a=HpAAvcLHHh0Zw7uRqdWCyQ==:117\r
+Received: from unknown (HELO lagos.xvx.ca) ([96.52.216.56])\r
+       by pd6ml1no-dmz.prod.shaw.ca with ESMTP; 18 Mar 2012 10:33:00 -0600\r
+Received: by lagos.xvx.ca (Postfix, from userid 1000)\r
+       id 232F5800483F; Sun, 18 Mar 2012 10:33:00 -0600 (MDT)\r
+From: Adam Wolfe Gordon <awg+notmuch@xvx.ca>\r
+To: notmuch@notmuchmail.org\r
+Subject: [PATCH v8 05/11] schemata: Add documentation for JSON reply format.\r
+Date: Sun, 18 Mar 2012 10:32:37 -0600\r
+Message-Id: <1332088363-22476-6-git-send-email-awg+notmuch@xvx.ca>\r
+X-Mailer: git-send-email 1.7.5.4\r
+In-Reply-To: <1332088363-22476-1-git-send-email-awg+notmuch@xvx.ca>\r
+References: <87fwd6kqtv.fsf@zancas.localnet>\r
+       <1332088363-22476-1-git-send-email-awg+notmuch@xvx.ca>\r
+X-BeenThere: notmuch@notmuchmail.org\r
+X-Mailman-Version: 2.1.13\r
+Precedence: list\r
+List-Id: "Use and development of the notmuch mail system."\r
+       <notmuch.notmuchmail.org>\r
+List-Unsubscribe: <http://notmuchmail.org/mailman/options/notmuch>,\r
+       <mailto:notmuch-request@notmuchmail.org?subject=unsubscribe>\r
+List-Archive: <http://notmuchmail.org/pipermail/notmuch>\r
+List-Post: <mailto:notmuch@notmuchmail.org>\r
+List-Help: <mailto:notmuch-request@notmuchmail.org?subject=help>\r
+List-Subscribe: <http://notmuchmail.org/mailman/listinfo/notmuch>,\r
+       <mailto:notmuch-request@notmuchmail.org?subject=subscribe>\r
+X-List-Received-Date: Sun, 18 Mar 2012 16:33:12 -0000\r
+\r
+---\r
+ devel/schemata |   27 +++++++++++++++++++++++++--\r
+ 1 files changed, 25 insertions(+), 2 deletions(-)\r
+\r
+diff --git a/devel/schemata b/devel/schemata\r
+index 24ad775..728a46f 100644\r
+--- a/devel/schemata\r
++++ b/devel/schemata\r
+@@ -77,8 +77,9 @@ part = {\r
+     content?:       string\r
+ }\r
+ \r
+-# The headers of a message (format_headers_json with raw headers) or\r
+-# a part (format_headers_message_part_json with pretty-printed headers)\r
++# The headers of a message (format_headers_json with raw headers\r
++# and reply = FALSE) or a part (format_headers_message_part_json\r
++# with pretty-printed headers)\r
+ headers = {\r
+     Subject:        string,\r
+     From:           string,\r
+@@ -136,3 +137,25 @@ thread = {\r
+                               # matched and unmatched\r
+     subject:        string\r
+ }\r
++\r
++notmuch reply schema\r
++--------------------\r
++\r
++reply = {\r
++    # The headers of the constructed reply (format_headers_json with\r
++    # raw headers and reply = TRUE)\r
++    reply-headers: reply_headers,\r
++\r
++    # As in the show format (format_part_json)\r
++    original: message\r
++}\r
++\r
++reply_headers = {\r
++    Subject:        string,\r
++    From:           string,\r
++    To?:            string,\r
++    Cc?:            string,\r
++    Bcc?:           string,\r
++    In-reply-to:    string,\r
++    References:     string\r
++}\r
+-- \r
+1.7.5.4\r
+\r