From 49720b0f6c7708465a57ad6a5d1a1c2b2b7367c3 Mon Sep 17 00:00:00 2001 From: daphtya <davidpanjaitan1@gmail.com> Date: Sat, 13 Apr 2019 19:04:28 +0700 Subject: [PATCH] update api endpoint pada readme --- readme.md | 51 +++++++++++++++++++++++++++++++++++++++++++++++---- 1 file changed, 47 insertions(+), 4 deletions(-) diff --git a/readme.md b/readme.md index 9579cdb..f9e8344 100644 --- a/readme.md +++ b/readme.md @@ -14,7 +14,7 @@ pip install PyJWT ## API Endpoints -Berikut adalah API dari backend server VIS-MASY: +Berikut adalah API endpoints dari backend server VIS-MASY: ### Login dan Register @@ -33,8 +33,14 @@ Berikut adalah API dari backend server VIS-MASY: * #### /api/get-user Method: POST Data request: Authorization header - Response: status, data user yang sesuai authorization - Meminta data user berdasarkan authorization token + Response: status, data + Mengirim data user lengkap berdasarkan authorization token + +* #### /api/get-user-public + Method: POST + Data request: user_id + Response: status, data + Mengirim data user yang bersifat publik * #### /api/register Method: POST @@ -58,9 +64,46 @@ Berikut adalah API dari backend server VIS-MASY: * #### /api/page/get Method: POST - Data request: data_id + Data request: page_id Response: status, data, subdata Mengirim data yang akan menjadi halaman dan subdata yang akan menjadi visualisasi ### Comment and Reply +* #### /api/comment/get + Method: POST + Data req: page_id + Response: status, data + Mengirim list comment dan reply-nya (jika ada) pada sebuah page dengan terurut waktu (yang terbaru paling awal) + +* #### /api/comment/get-unreplied + Method: POST + Data req: page_id + Response: status, data + Mengirim list comment yang belum direply pada page dengan terurut waktu (yang terbaru paling awal) + +* #### /api/comment/add + Method: POST + Data req: Authorization header, page_id, text + Response: status, message + Menambahkan sebuah comment dari user yang sesuai authorization pada sebuah page + +* #### /api/comment/add-reply + Method: POST + Data req: Authorization header, comment_id, text + Response: status, message + Menambahkan sebuah reply pada sebuah comment jika comment tersebut dalam wewenang user pada authorization + +### Administration + +* #### /api/admin/add-page + Method: POST + Data req: Authorization header, admin_id, page_id + Response: status, message + Menambah page yang diadministrasi seorang admin jika authorization level SUPERADMIN + +* #### /api/admin/remove-page + Method: POST + Data req: Authorization header, admin_id, page_id + Response: status, message + Mengurangi page yang diadministrasi seorang admin jika authorization level SUPERADMIN \ No newline at end of file -- GitLab