From 3e9aef409caa846003accf6d2b9171c003bbf066 Mon Sep 17 00:00:00 2001 From: mpl Date: Wed, 24 Oct 2012 17:26:46 +0200 Subject: [PATCH] search handler: documented the "attr" values when searching for a permanode Change-Id: I607d1fe016078912faac9864630552cd2b496aa2 --- pkg/search/handler.go | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/pkg/search/handler.go b/pkg/search/handler.go index 8f624bc2f..92d7260f2 100644 --- a/pkg/search/handler.go +++ b/pkg/search/handler.go @@ -166,7 +166,10 @@ func (sh *Handler) serveRecentPermanodes(rw http.ResponseWriter, req *http.Reque dr.PopulateJSON(ret) } -// TODO(mpl): configure and/or document the name of the possible attributes in the http request +// servePermanodesWithAttr uses the indexer to search for the permanodes matching +// the request. +// The valid values for the "attr" key in the request (i.e the only attributes +// for a permanode which are actually indexed as such) are "tag" and "title". func (sh *Handler) servePermanodesWithAttr(rw http.ResponseWriter, req *http.Request) { ret := jsonMap() defer httputil.ReturnJSON(rw, ret)