apidoc for like & dislike
This commit is contained in:
parent
ded4927ae4
commit
afd4107ac3
@ -716,12 +716,60 @@ class API(object):
|
|||||||
|
|
||||||
return fetched_list
|
return fetched_list
|
||||||
|
|
||||||
|
"""
|
||||||
|
@apiDefine likeResponse
|
||||||
|
@apiSuccess {number} likes
|
||||||
|
The (new) number of likes on the comment.
|
||||||
|
@apiSuccess {number} dislikes
|
||||||
|
The (new) number of dislikes on the comment.
|
||||||
|
"""
|
||||||
|
|
||||||
|
"""
|
||||||
|
@api {post} /id/:id/like like
|
||||||
|
@apiGroup Comment
|
||||||
|
@apiDescription
|
||||||
|
Puts a “like” on a comment. The author of a comment cannot like its own comment.
|
||||||
|
|
||||||
|
@apiParam {number} id
|
||||||
|
The id of the comment to like.
|
||||||
|
|
||||||
|
@apiExample {curl} Like comment with id 23:
|
||||||
|
curl -X POST 'https://comments.example.com/id/23/like'
|
||||||
|
|
||||||
|
@apiUse likeResponse
|
||||||
|
|
||||||
|
@apiSuccessExample Example response
|
||||||
|
{
|
||||||
|
"likes": 5,
|
||||||
|
"dislikes": 2
|
||||||
|
}
|
||||||
|
"""
|
||||||
@xhr
|
@xhr
|
||||||
def like(self, environ, request, id):
|
def like(self, environ, request, id):
|
||||||
|
|
||||||
nv = self.comments.vote(True, id, utils.anonymize(str(request.remote_addr)))
|
nv = self.comments.vote(True, id, utils.anonymize(str(request.remote_addr)))
|
||||||
return JSON(nv, 200)
|
return JSON(nv, 200)
|
||||||
|
|
||||||
|
"""
|
||||||
|
@api {post} /id/:id/dislike dislike
|
||||||
|
@apiGroup Comment
|
||||||
|
@apiDescription
|
||||||
|
Puts a “dislike” on a comment. The author of a comment cannot dislike its own comment.
|
||||||
|
|
||||||
|
@apiParam {number} id
|
||||||
|
The id of the comment to dislike.
|
||||||
|
|
||||||
|
@apiExample {curl} Dislike comment with id 23:
|
||||||
|
curl -X POST 'https://comments.example.com/id/23/dislike'
|
||||||
|
|
||||||
|
@apiUse likeResponse
|
||||||
|
|
||||||
|
@apiSuccessExample Example response
|
||||||
|
{
|
||||||
|
"likes": 4,
|
||||||
|
"dislikes": 3
|
||||||
|
}
|
||||||
|
"""
|
||||||
@xhr
|
@xhr
|
||||||
def dislike(self, environ, request, id):
|
def dislike(self, environ, request, id):
|
||||||
|
|
||||||
|
Loading…
Reference in New Issue
Block a user