diff options
| author | Pierre-Yves Chibon <pingou@pingoured.fr> | 2012-03-29 17:02:47 +0200 |
|---|---|---|
| committer | Pierre-Yves Chibon <pingou@pingoured.fr> | 2012-03-29 17:02:47 +0200 |
| commit | 85d040687fc21f13f3a124eb88f154027e052da1 (patch) | |
| tree | 5fcba4e35080f8ea9773f711c3d178b1a77faad2 /templates/api.html | |
| parent | 547ab59c2c0477d98ece16a264e2c56f1b04a822 (diff) | |
| download | hyperkitty-85d040687fc21f13f3a124eb88f154027e052da1.tar.gz hyperkitty-85d040687fc21f13f3a124eb88f154027e052da1.tar.xz hyperkitty-85d040687fc21f13f3a124eb88f154027e052da1.zip | |
Add Search facility to the REST API
Diffstat (limited to 'templates/api.html')
| -rw-r--r-- | templates/api.html | 20 |
1 files changed, 20 insertions, 0 deletions
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/<list name>/<field>/<keyword></a></h3> + <p> + </p> + <p> +Using the address /api/search/<list name>/<field>/<keyword> 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 %} |