Skip to content

Commit 1fa1e56

Browse files
committedJan 20, 2018
Document searching
1 parent 3972779 commit 1fa1e56

File tree

1 file changed

+10
-0
lines changed

1 file changed

+10
-0
lines changed
 

‎README.md

+10
Original file line numberDiff line numberDiff line change
@@ -74,3 +74,13 @@ If the request is authenticated and the `capcode` parameter is also specified, t
7474

7575
To make a new reply, send the `board`, `parent` and `content` parameters in a POST request to `/reply`.
7676
If the request is authenticated and the `capcode` parameter is also specified, the post will be made with the capcode of the authenticated janitor.
77+
78+
## Searching
79+
80+
The routes for searching are `/api/v2/search` and `/api/v2/advanced_search`. The first one searches only titles, the second one searches titles and contents. Archived threads cannot have their contents searched, but will still appear in both listings if their title matches.
81+
The required `POST` parameters include:
82+
83+
- `board_select` Board to search. Must be set to all to search all boards
84+
- `search_text` Needle
85+
86+
Hashes for threads in search results may not contain all keys. This is not exclusive to archived threads.

0 commit comments

Comments
 (0)
Please sign in to comment.