Crealcs Development DokuWiki

base : /api

GET /code –> Swagger
GET /code/< code> –> Le contenu du code (Utilisateur, Rubrique ou Info)
DELETE /code/< code> –> Supprime l'entrée dans la table correspondante, mais pas dans la table des codes (pas de - réutilisation possible)
~~PUT /code/< code> –> Ne devrait pas être possible, ni nécessaire~~
~~PATCH /code/< code> –> Ne devrait pas être possible, ni nécessaire~~
~~POST/code/< code> –> Ne devrait pas être possible, ni nécessaire~~

GET /heading –> Swagger
GET /heading/<heading> –> Restitue les éléments intrinsèques de la rubrique (nom, description)
PUT /heading/ –> Créer une nouvelle rubrique
PATCH /heading/<heading> –> Modifier le descriptif de la rubrique
DELETE /heading/<heading> –> Supprimer la rubrique
~~POST /heading –> Pas de cas pour l'instant~~

GET /item –> Swagger
GET /item/<item> –> Restitue les éléments intrinsèques de l'info (nom, description, validité, paramètres)
PUT /item/ –> Créer une nouvelle infos
PATCH /item/<item> –> modifier les paramètres de l'info
DELETE /item/<item> –> Supprimer l'info
~~POST /item –> Pas de cas pour l'instant~~

GET /sower –> Liste des utilisateurs (pour admin seulement)
GET /sower/<sower> –> Elément liés à l'utilisateur (*)
PUT /sower –> Créer une nouvel utilisateur (quid de la création quand c'est à partir d'un réseau social)
PATCH /sower/<sower> –> modifier les paramètres utilisateur
DELETE /sower/<sower> –> supprimer un utilisateur
POST /sower/login –> connexion utilisateur
POST /sower/<sower>/logout –> déconnexion utilisateur
POST /sower/<sower>/changePassword –> changement de mot de passe (version non sociale)
POST /sower/sociallogin –> connexion utilisateur par réseau social

GET /sower/<sower>/heading –> Liste des rubriques de l'utilisateur (*)
GET /sower/<sower>/heading/<heading>/item –> Liste des infos d'une rubrique de l'utilisateur (*)

GET /sower/<sower>/awitingNotifs –> Liste des notifications non acquittées et non expirées pour l'utilisateur (*)
GET /sower/<sower>/awitingNotifNum –> Nombre de notifications non acquittées et non expirées pour l'utilisateur (*)
POST /sower/<sower>/notification/<notification>/acknowledge → acquitter une notification (marquer comme lue, n'apparait plus)

Optionnel / plus tard

GET /sower/<sower>/authorization –> Liste des autorisations accordées par l'utilisateur à ceux qui voient son profil (*)
PATCH /sower/<sower>/authorization –> modifier les autorisations données par l'utilisateur (*)

PUT /sower/<sower>/warehouse/ –> stockage d'un codes externes par l'utilisateur avec une note personnelle
PATCH /sower/<sower>/warehouse/< code> –> modification d'une note sur un codes externes stocké par l'utilisateur (devrait remplacer le PATCH /warehouse/<warehouse>)
DELETE /sower/<sower>/warehouse/< code> –> suppression du stockage d'un codes externes stocké par l'utilisateur (devrait remplacer le DELETE /warehouse/<warehouse>)

GET /sower/<sower>/statistics –> agrégat de statistiques autour des données de l'utilisateur et de ses codes
PUT /like –> recevoir un like concernant l'application (afin d'en faire la promotion)
POST /sower/<sower>/share –> envoyer un code (avec un message) par mail/notification à une liste de connaissance dans l'application

Pour les admins

GET /system/option –> liste des options
GET /system/option/<option> –> voir l'option <option>
PATCH /system/option/<option> → mettre à jour l'option <option>
GET /system/admin –> liste des admins
PUT /system/admin/<sower> –> nouvel admin : <sower>
DELETE /system/admin/<sower> –> retirer le droit admin à <sower>
GET /system/ban → liste des utilisateurs à qui on a retiré le droit de se connecter
PUT /system/ban/<sower> → retirer le droit de se connecter à un utilisateur
DELETE /system/ban/<sower> → restituer le droits de se connecter à un utilisateur
GET /system/statistics

(*)s'il est connecté et qu'il demande ces propres infos