Create comments.md

luc · May 27, 2018 · 541a0ab · 541a0ab
1 parent 17e0638
commit 541a0ab
Showing 1 changed file with 15 additions and 0 deletions.
diff --git a/content/comments.md b/content/comments.md
@@ -0,0 +1,15 @@
+Comments
+=====
+
+### `GET /v2/comments.json`
+
+| Parameter                       | Required | Example                                                                                                                                           |
+| ------------------------------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `id: number`                    | false    | `GET /v2/comments.json?id=1`  will get the comment with the id 1.|
+| `author: string`                | false    | `GET /v2/comments.json?author=luc`  will get all comments from luc|
+
+
+**Status Codes**
+
+- `200 OK` will be returned if found
+- `404 Not Found` will be returned if no news are found