From 97ee5639e53632c5a548b28421532ea71d5c9725 Mon Sep 17 00:00:00 2001 From: Max Goodman Date: Tue, 1 Oct 2013 18:10:10 -0700 Subject: [PATCH] /dev/api: Document POST_search_reddit_names. --- r2/r2/controllers/api.py | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/r2/r2/controllers/api.py b/r2/r2/controllers/api.py index f7ab9d538..52d9df1a2 100755 --- a/r2/r2/controllers/api.py +++ b/r2/r2/controllers/api.py @@ -3268,7 +3268,15 @@ class ApiController(RedditController, OAuth2ResourceController): @json_validate(query=VPrintable('query', max_length=50), include_over_18=VBoolean('include_over_18', default=True)) + @api_doc(api_section.subreddits, extensions=["json"]) def POST_search_reddit_names(self, responder, query, include_over_18): + """List subreddit names that begin with a query string. + + Subreddits whose names begin with `query` will be returned. If + `include_over_18` is false, subreddits with over-18 content + restrictions will be filtered from the results. + + """ names = [] if query: names = search_reddits(query, include_over_18)