aboutsummaryrefslogtreecommitdiff
path: root/API.md
diff options
context:
space:
mode:
authorrr-2016-04-24 11:22:18 +0200
committerrr-2016-04-24 11:24:36 +0200
commitb75cfff8f7ca05840cdbf6308cbd2aa0a8e173ae (patch)
tree2cdf267bb96f5a7c375b1c4ae0e3d618d1d85f40 /API.md
parent10f8f443f1d63c9384c94b6b32327b5955c6ed90 (diff)
server/comments: add comment retrieving
Diffstat (limited to 'API.md')
-rw-r--r--API.md26
1 files changed, 25 insertions, 1 deletions
diff --git a/API.md b/API.md
index 44468b3..4dd6d72 100644
--- a/API.md
+++ b/API.md
@@ -42,7 +42,7 @@
- ~~Listing comments~~
- [Creating comment](#creating-comment)
- [Updating comment](#updating-comment)
- - ~~Getting comment~~
+ - [Getting comment](#getting-comment)
- [Deleting comment](#deleting-comment)
- ~~Rating comment~~
- Users
@@ -740,6 +740,30 @@ data.
Updates an existing comment text.
+## Getting comment
+- **Request**
+
+ `GET /comment/<id>`
+
+- **Output**
+
+ ```json5
+ {
+ "comment": <comment>
+ }
+ ```
+ ...where `<comment>` is a [comment resource](#comment).
+
+- **Errors**
+
+ - the comment does not exist
+ - privileges are too low
+
+- **Description**
+
+ Retrieves information about an existing comment.
+
+
## Deleting comment
- **Request**

© 2015 - 2026 Jakob L. Kreuze