From 85d040687fc21f13f3a124eb88f154027e052da1 Mon Sep 17 00:00:00 2001
From: Pierre-Yves Chibon <pingou@pingoured.fr>
Date: Thu, 29 Mar 2012 17:02:47 +0200
Subject: Add Search facility to the REST API

---
 templates/api.html | 20 ++++++++++++++++++++
 1 file changed, 20 insertions(+)

(limited to 'templates/api.html')

diff --git a/templates/api.html b/templates/api.html
index ba3abb4..afabbb4 100644
--- a/templates/api.html
+++ b/templates/api.html
@@ -56,4 +56,24 @@ retrieve the all the email for a specific thread on the specified mailing-list.
         </a>
         </p>
     </div>
+        <div class="even" style="padding-left: 1em">
+        <h3>Search <a>/api/search/&lt;list name&gt;/&lt;field&gt;/&lt;keyword&gt;</a></h3>
+        <p>
+        </p>
+        <p>
+Using the address /api/search/&lt;list name&gt;/&lt;field&gt;/&lt;keyword&gt; you will be able to
+search for all emails of the specified mailing-list containing the provided keyword in the given field.
+        </p>
+        <p>The list of available field is:</p>
+        <ul>
+            <li>From</li>
+            <li>Subject</li>
+            <li>Content</li>
+            <li>SubjectContent</li>
+        </ul>
+        <p> For example: <a href="/api/search/devel@fp.o/From/pingoured">
+            /api/search/devel@fp.o/From/pingoured
+        </a>
+        </p>
+    </div>
 {% endblock %}
-- 
cgit