API DOCS updated

README.md

@@ -44,7 +44,7 @@ And, you can learn about API in `util/APIDOCS.md`.
 | Send | 🟢 | HIGH |
 | Delete | 🟢 | HIGH |
 | React | 🟢 | MEDIUM |
-| Edit | 🔴 | HIGH |
+| Edit | 🔴 | MEDIUM |
 
 ### Threads
 | To do | Is done? | Priority |
@@ -52,7 +52,7 @@ And, you can learn about API in `util/APIDOCS.md`.
 | Ratelimit | 🟢 | HIGH |
 | Create | 🟢 | HIGH |
 | Delete | 🟢 | HIGH |
-| Edit | 🔴 | HIGH |
+| Edit | 🔴 | MEDIUM |
 
 ### API
 | To do | Is done? | Priority |
@@ -61,14 +61,8 @@ And, you can learn about API in `util/APIDOCS.md`.
 | Send message | 🟢 | MEDIUM |
 | Create thread | 🟢 | MEDIUM |
 | Get info about thread | 🟢 | MEDIUM |
-<<<<<<< HEAD
+| Delete message & thread | 🔴 | HIGH |
-| Delete message & thread | 🔴 | MEDIUM |
+| Edit message & thread | 🔴 | HIGH |
-| Edit message & thread | 🔴 | MEDIUM |
-
-=======
-| Delete message | 🔴 | MEDIUM |
-| React | 🟢 | MEDIUM |
->>>>>>> 9f10a32b7ce05cbb81acacb8277b68c25d4baa34
 
 ### Other
 | To do | Is done? | Priority |
@@ -77,7 +71,7 @@ And, you can learn about API in `util/APIDOCS.md`.
 | Multi-theme support | 🔴 | LOW |
 | Search | 🔴 | MEDIUM |
 | Better view | 🟢 | MEDIUM |
-| Sending message etc. will use fetch API | 🔴 | HIGH |
+| Sending message etc. will use fetch API | 🟡 | HIGH |
 
 ## Screenshot
 ![akf-forum](https://user-images.githubusercontent.com/70021050/160255959-ef216cba-1348-4d4b-9347-fe67e21348e7.png)

tests/get_msg.py

@@ -14,7 +14,6 @@ print(r.json())
 example_response = {
     'status': 200,
     'result': {
-        'authorID': 0,
         'content': 'a',
         'author': {
             'name': 'Akif9748',
@@ -22,14 +21,14 @@ example_response = {
             'time': 1649189944864,
             'admin': False,
             'deleted': False,
-            'id': 0
+            'id': "0"
         },
         'time': 1649189950166,
-        'threadID': 0,
+        'threadID': "0",
         'deleted': False,
         'edited': False,
         # Reactions: {userid: isLike (Bool)}
         'react': {'0': True},
-        'id': 0
+        'id': "0"
     }
 }

tests/get_thread.py

@@ -20,12 +20,12 @@ example_response = {
             "time": 1647895891332,
             "admin": False,
             "deleted": False,
-            "id": 0
+            "id": "0"
         },
         "title": "First Thread",
-        "messages": [0, 1, 2, 3],
+        "messages": ["0", "1", "2", "3"],
         "time": 1647895907054,
         "deleted": False,
-        "id": 0
+        "id": "0"
     }
 }

tests/get_user.py

@@ -19,6 +19,6 @@ example_response = {
         'time': 1647895891332,
         'admin': True,
         'deleted': False,
-        'id': 0
+        'id': "0"
     }
 }

tests/post_msg.py

@@ -27,24 +27,13 @@ example_response = {
             'time': 1649009854217,
             'admin': False,
             'deleted': False,
-            'id': 2
+            'id': "2"
         },
         'time': 1649010863471,
-        'thread':  {
+        'threadID': "1",
-            'author': {
-                'name': 'Akif9748',
-                'avatar': 'https://www.technopat.net/sosyal/data/avatars/o/298/298223.jpg?1644694020',
-                'time': 1647895891332, 'admin': True, 'deleted': False, 'id': 0
-            },
-            'title': 'API TEST',
-            'messages': [4, 6],
-            'time': 1649010834064,
-            'deleted': False,
-            'id': 1
-        },
         'deleted': False,
         'edited': False,
         'react': {},
-        'id': 6
+        'id': "6"
     }
 }

tests/post_msg_react.py

@@ -0,0 +1,17 @@
+import requests
+
+# Headers for login to Akf-forum
+headers = {
+    "username": "testUser",
+    "password": "testPassword"
+}
+
+r = requests.post("http://localhost:3000/api/messages/0/react/like",
+                  headers=headers)
+
+print(r.json())
+
+example_response = {
+    'status': 200,
+    'result': 1 # Number of likes
+}

tests/post_thread.py

@@ -20,31 +20,17 @@ print(r.json())
 example_response = {
     'status': 200,
     'result': {
-        'content': 'This message sent via API',
-        'author': {
-            'name': 'testUser',
-            'avatar': '',
-            'time': 1649009854217,
-            'admin': False,
-            'deleted': False,
-            'id': 2
-        },
-        'time': 1649010863471,
-        'thread':  {
         'author': {
             'name': 'Akif9748',
             'avatar': 'https://www.technopat.net/sosyal/data/avatars/o/298/298223.jpg?1644694020',
-                'time': 1647895891332, 'admin': True, 'deleted': False, 'id': 0
+            'time': 1647895891332, 'admin': True, 'deleted': False, 'id': "0"
         },
         'title': 'API TEST',
-            'messages': [4, 6],
+        'messages': ["4", "6"],
         'time': 1649010834064,
         'deleted': False,
-            'id': 1
-        },
-        'deleted': False,
         'edited': False,
-        'react': {},
+        'id': "1",
-        'id': 6
+
     }
 }

util/APIDOCS.md

@@ -16,15 +16,12 @@ You need this headers for send request to API:
 
 ## How to request?
 
-### Request type:
+### Request types:
-  `GET /api/action` 
+- GET `/api/messages/:id`
-
+- GET `/api/users/:id` 
-### "action" types:
+- GET `/api/threads/:id`  
-- GET `messages/:id`
+- POST `/api/messages` 
-- GET `users/:id` 
+- POST `/api/messages/:id/react/:type` 
-- GET `threads/:id`  
-- POST `messages` 
-
 
 ### Example request:
 ```GET /api/message/1```
@@ -40,28 +37,15 @@ You need this headers for send request to API:
         "deleted": false,
         "edited": false,
         "react": {},
-        "id": 1,
+        "id": "1",
         "author": {
             "name": "ForumcuCocuk",
             "avatar": "/images/guest.png",
             "time": 1647177723873,
             "admin": true,
-            "id": 1
+            "id": "1"
         },
-        "thread": {
+        "threadID":"0" 
-            "author": {
-                "name": "Akif9748",
-                "avatar": "/images/guest.png",
-                "time": 1647177705200,
-                "admin": true,
-                "id": 0
-            },
-            "title": "First Thread",
-            "messages": [0, 1], 
-            "time": 1647178870047,
-            "deleted": false,
-            "id": 0
-        }   
     }
 }