From 9faf15b4b88f1bf636b1e7376a521c60681c3228 Mon Sep 17 00:00:00 2001 From: ynerant Date: Thu, 2 Apr 2020 16:08:51 +0200 Subject: [PATCH] Update Api --- Apps/Api.md | 29 ++++++++++++++++++++++++++++- 1 file changed, 28 insertions(+), 1 deletion(-) diff --git a/Apps/Api.md b/Apps/Api.md index b980bb5..511cc94 100644 --- a/Apps/Api.md +++ b/Apps/Api.md @@ -1,3 +1,30 @@ # API -La NoteKfet2020 dispose d'une API REST. Elle est accessible sur `/api/`. +La NoteKfet2020 dispose d'une API REST. Elle est accessible sur `/api/`. Elle supporte les requêtes GET, POST, HEAD, PUT, PATCH et DELETE (peut varier selon les pages). + +## Pages de l'API + +Il suffit d'ajouter le préfixe `/api/` pour arriver sur ces pages. + +* `models` (liste des différents modèles enregistrés en base de données) +* `user` (liste des différents utilisateurs enregistrés) +* `members/profile` (liste des différents profils associés à des utilisateurs) +* `members/club` (liste des différents clubs enregistrés) +* `members/role` (liste des différents rôles au sein des clubs existant) +* `members/membership` (liste des adhésions enregistrées) +* `activity/activity` (liste des activités recensées) +* `activity/type` (liste des différents types d'activités : pots, soirées de club, ...) +* `activity/guest` (liste des personnes invitées lors d'une activité) +* `activity/entry` (liste des entrées effectuées lors des activités) +* `note/note` (liste des notes enregistrées) +* `note/alias` (liste des alias enregistrés) +* `note/transaction/category` (liste des différentes catégories de boutons : soft, alcool, ...) +* `note/transaction/transaction` (liste des transactions effectuées) +* `note/transaction/template` (liste des boutons enregistrés) +* `treasury/invoice` (liste des factures générées) +* `treasury/product` (liste des produits associés à des factures) +* `treasury/remittance_type` (liste des types de remises supportés : chèque) +* `treasury/remittance` (liste des différentes remises enregistrées) +* `permission/permission` (liste de toutes les permissions enregistrées) +* `permission/roles` (liste des permissions octroyées pour chacun des rôles) +* `logs` (liste des modifications enregistrées en base de données) \ No newline at end of file