LBRYCommunity/lighthouse.js
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

Updated api documentation

Browse source 
Updated api documentation to match the api
This commit is contained in:
Fillerino 2017-09-20 22:41:11 +02:00 committed by GitHub
parent 46278b3807
commit 8d364be153
1 changed files with 8 additions and 12 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

20
server/routes/lighthouse.js
View file

@ -15,15 +15,13 @@ router.prefix(`/${baseApi}/${api}`);
router.get('/', LighthouseControllers.info);
/**
* @api {post} /search Main Search API
* @api {get} /search Main Search API
* @apiGroup Search
* @apiParam {String} input The search text (Required)
* @apiParam {String} s The search text (Required)
* @apiParam {Integer} size Amount of results to return as max
* @apiParam {Integer} from The number to start from, good for pagination.
* @apiParamExample {json} Input
* {
* "input": "fillerino", "size": 10, "from": 2
* }
* @apiParamExample {url} Example
* http://localhost/api/lighthouse/search?s=fillerino
* @apiSuccess {Array[]} array List of search response, each containing the value below.
* @apiSuccess {Object[]} result A search result
* @apiSuccess {String} result.name The name of the claim.
@ -68,13 +66,11 @@ router.get('/', LighthouseControllers.info);
router.get('/search', LighthouseControllers.search);
/**
* @api {post} /autocomplete Autocomplete API
* @api {get} /autocomplete Autocomplete API
* @apiGroup Search
* @apiParam {String} input The text to be autocompleted (Required).
* @apiParamExample {json} Input
* {
* "input": "fillerino"
* }
* @apiParam {String} s The text to be autocompleted (Required).
* @apiParamExample {url} Example
* http://localhost/api/lighthouse/autocomplete?s=fillerino
* @apiSuccess {Array[]} array List of search response, each containing the value below.
* @apiSuccessExample {json} Success
* HTTP/1.1 200 OK