summaryrefslogtreecommitdiff
path: root/doc/api-comment-procedures.markdown
diff options
context:
space:
mode:
Diffstat (limited to 'doc/api-comment-procedures.markdown')
-rw-r--r--doc/api-comment-procedures.markdown182
1 files changed, 182 insertions, 0 deletions
diff --git a/doc/api-comment-procedures.markdown b/doc/api-comment-procedures.markdown
new file mode 100644
index 00000000..33a856ea
--- /dev/null
+++ b/doc/api-comment-procedures.markdown
@@ -0,0 +1,182 @@
+API Comment Procedures
+======================
+
+### createComment
+
+- Purpose: **Create a new comment**
+- Parameters:
+ - **task_id** (integer, required)
+ - **user_id** (integer, required)
+ - **content** Markdown content (string, required)
+- Result on success: **comment_id**
+- Result on failure: **false**
+
+Request example:
+
+```json
+{
+ "jsonrpc": "2.0",
+ "method": "createComment",
+ "id": 1580417921,
+ "params": {
+ "task_id": 1,
+ "user_id": 1,
+ "content": "Comment #1"
+ }
+}
+```
+
+Response example:
+
+```json
+{
+ "jsonrpc": "2.0",
+ "id": 1580417921,
+ "result": 11
+}
+```
+
+### getComment
+
+- Purpose: **Get comment information**
+- Parameters:
+ - **comment_id** (integer, required)
+- Result on success: **comment properties**
+- Result on failure: **null**
+
+Request example:
+
+```json
+{
+ "jsonrpc": "2.0",
+ "method": "getComment",
+ "id": 867839500,
+ "params": {
+ "comment_id": 1
+ }
+}
+```
+
+Response example:
+
+```json
+{
+ "jsonrpc": "2.0",
+ "id": 867839500,
+ "result": {
+ "id": "1",
+ "task_id": "1",
+ "user_id": "1",
+ "date_creation": "1410881970",
+ "comment": "Comment #1",
+ "username": "admin",
+ "name": null
+ }
+}
+```
+
+### getAllComments
+
+- Purpose: **Get all available comments**
+- Parameters:
+ - **task_id** (integer, required)
+- Result on success: **List of comments**
+- Result on failure: **false**
+
+Request example:
+
+```json
+{
+ "jsonrpc": "2.0",
+ "method": "getAllComments",
+ "id": 148484683,
+ "params": {
+ "task_id": 1
+ }
+}
+```
+
+Response example:
+
+```json
+{
+ "jsonrpc": "2.0",
+ "id": 148484683,
+ "result": [
+ {
+ "id": "1",
+ "date_creation": "1410882272",
+ "task_id": "1",
+ "user_id": "1",
+ "comment": "Comment #1",
+ "username": "admin",
+ "name": null
+ },
+ ...
+ ]
+}
+```
+
+### updateComment
+
+- Purpose: **Update a comment**
+- Parameters:
+ - **id** (integer, required)
+ - **content** Markdown content (string, required)
+- Result on success: **true**
+- Result on failure: **false**
+
+Request example:
+
+```json
+{
+ "jsonrpc": "2.0",
+ "method": "updateComment",
+ "id": 496470023,
+ "params": {
+ "id": 1,
+ "content": "Comment #1 updated"
+ }
+}
+```
+
+Response example:
+
+```json
+{
+ "jsonrpc": "2.0",
+ "id": 1493368950,
+ "result": true
+}
+```
+
+### removeComment
+
+- Purpose: **Remove a comment**
+- Parameters:
+ - **comment_id** (integer, required)
+- Result on success: **true**
+- Result on failure: **false**
+
+Request example:
+
+```json
+{
+ "jsonrpc": "2.0",
+ "method": "removeComment",
+ "id": 328836871,
+ "params": {
+ "comment_id": 1
+ }
+}
+```
+
+Response example:
+
+```json
+{
+ "jsonrpc": "2.0",
+ "id": 328836871,
+ "result": true
+}
+```