vmario/docs
1
0
Fork 0
mirror of https://github.com/sismics/docs.git synced 2024-11-22 05:57:57 +01:00
Code Issues Packages Projects Releases Wiki Activity

#241: update API doc

Browse Source
This commit is contained in:
Benjamin Gamard 2018-10-21 01:23:45 +02:00
parent 40c1ff0e1a
commit 7665eb6bf2
1 changed files with 2 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
docs-web/src/main/java/com/sismics/docs/rest/resource/DocumentResource.java
View File

@ -325,6 +325,7 @@ public class DocumentResource extends BaseResource {
* @apiSuccess {Number} total Total number of documents * @apiSuccess {Number} total Total number of documents
* @apiSuccess {Object[]} documents List of documents * @apiSuccess {Object[]} documents List of documents
* @apiSuccess {String} documents.id ID * @apiSuccess {String} documents.id ID
* @apiSuccess {String} documents.highlight Search highlight (for fulltext search)
* @apiSuccess {String} documents.title Title * @apiSuccess {String} documents.title Title
* @apiSuccess {String} documents.description Description * @apiSuccess {String} documents.description Description
* @apiSuccess {Number} documents.create_date Create date (timestamp) * @apiSuccess {Number} documents.create_date Create date (timestamp)
@ -338,6 +339,7 @@ public class DocumentResource extends BaseResource {
* @apiSuccess {String} documents.tags.id ID * @apiSuccess {String} documents.tags.id ID
* @apiSuccess {String} documents.tags.name Name * @apiSuccess {String} documents.tags.name Name
* @apiSuccess {String} documents.tags.color Color * @apiSuccess {String} documents.tags.color Color
* @apiSuccess {String[]} suggestions List of search suggestions
* @apiError (client) ForbiddenError Access denied * @apiError (client) ForbiddenError Access denied
* @apiError (server) SearchError Error searching in documents * @apiError (server) SearchError Error searching in documents
* @apiPermission user * @apiPermission user