diff options
| author | rr- | 2016-04-24 09:50:11 +0200 |
|---|---|---|
| committer | rr- | 2016-04-24 10:31:49 +0200 |
| commit | 612734e9ff7b6ca500bbf8247314804e1f806a09 (patch) | |
| tree | a097000d617684633b15368f13610f81d3aafe80 /API.md | |
| parent | 6e6c57d44a3255f277542d01a9de7c3decfe1c4c (diff) | |
server/comments: add comment creating
Diffstat (limited to 'API.md')
| -rw-r--r-- | API.md | 74 |
1 files changed, 71 insertions, 3 deletions
@@ -33,11 +33,18 @@ - ~~Updating post~~ - ~~Getting post~~ - ~~Deleting post~~ - - ~~Scoring posts~~ - - ~~Adding posts to favorites~~ - - ~~Removing posts from favorites~~ + - ~~Rating post~~ + - ~~Adding post to favorites~~ + - ~~Removing post from favorites~~ - [Getting featured post](#getting-featured-post) - [Featuring post](#featuring-post) + - Comments + - ~~Listing comments~~ + - [Creating comment](#creating-comment) + - ~~Updating comment~~ + - ~~Getting comment~~ + - ~~Deleting comment~~ + - ~~Rating comment~~ - Users - [Listing users](#listing-users) - [Creating user](#creating-user) @@ -58,6 +65,7 @@ - [Tag category](#tag-category) - [Tag](#tag) - [Post](#post) + - [Comment](#comment) - [Snapshot](#snapshot) 4. [Search](#search) @@ -665,6 +673,40 @@ data. Features a post on the main page in web client. +## Creating comment +- **Request** + + `POST /comments/` + +- **Input** + + ```json5 + { + "text": <text>, + "postId": <post-id> + } + ``` + +- **Output** + + ```json5 + { + "comment": <comment> + } + ``` + ...where `<comment>` is a [comment resource](#comment). + +- **Errors** + + - post does not exist + - comment text is empty + - privileges are too low + +- **Description** + + Creates a new comment under given post. + + ## Listing users - **Request** @@ -1174,6 +1216,32 @@ One file together with its metadata posted to the site. - `<last-feature-time>`: the last time the post was featured, formatted as per RFC 3339. +## Comment +**Description** + +A comment under a post. + +**Structure** + +```json5 +{ + "id": <comment-id>, + "post": <post>, + "user": <author> + "text": <text>, + "creationTime": <creation-time>, + "lastEditTime": <last-edit-time> +} +``` + +**Field meaning** +- `<id>`: the comment identifier. +- `<post>`: a post resource the post is linked with. +- `<author>`: a user resource the post is created by. +- `<creation-time>`: time the comment was created, formatted as per RFC 3339. +- `<last-edit-time>`: time the comment was edited, formatted as per RFC 3339. + + ## Snapshot **Description** |