1
0
Fork 0
mirror of https://github.com/sbrl/Pepperminty-Wiki.git synced 2024-12-22 13:45:02 +00:00

Add apiDoc comment

This commit is contained in:
Starbeamrainbowlabs 2019-08-23 01:27:35 +01:00
parent e6ba31df23
commit 632375417d
Signed by: sbrl
GPG key ID: 1BE5172E637709C2

View file

@ -317,6 +317,16 @@ register_module([
exit(json_encode($result, JSON_PRETTY_PRINT));
});
/**
* @api {get} ?action=stas-parse&query={text} Debug search queries
* @apiDescription Debug Pepperminty Wiki's understanding of search queries.
* If you want something machine-readable, check out the new stas property on the object returned by query-searchindex.
* @apiName SearchSTASParse
* @apiGroup Search
* @apiPermission Anonymous
*
* @apiParam {string} query The query string to parse.
*/
add_action("stas-parse", function() {
global $settings;