Crealcs Development DokuWiki

Ceci est une ancienne révision du document !

---

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

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

Optionnel / plus tard

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

• GET /sewer/<sewer>/warehouse –> Liste des codes stockés par l'utilisateur (*)
• PUT /sewer/<sewer>/warehouse/ –> stockage d'un codes externes par l'utilisateur avec une note personnelle
• PATCH /sewer/<sewer>/warehouse/< code> –> modification d'une note sur un codes externes stocké par l'utilisateur
• DELETE /sewer/<sewer>/warehouse/< code> –> suppression du stockage d'un codes externes stocké par l'utilisateur

• GET /sewer/<sewer>/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 /sewer/<sewer>/share –> envoyer un code (avec un message) par mail/notification à une liste de connaissance dans l'application

• GET /sewer/<sewer>/notification –> vérifier s'il y a au moins une notification non acquittée (*)
• GET /sewer/<sewer>/notification/<notification> –> obtenir le contenu d'une notification en particulier (*)
• POST /sewer/<sewer>/notification/<notification>/ack

• POST /report/bug –> rapporter un dysfonctionnement
• POST /report/misuse –> rapporter un comportement/contenu inapproprié

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/<sewer> –> nouvel admin : <sewer>
• DELETE /system/admin/<sewer> –> retirer le droit admin à <sewer>
• POST /sewer/<sewer>/ban → retirer le droits de se connecter à un utilisateur
• POST /sewer/<sewer>/unban → restituer le droits de se connecter à un utilisateur
• GET /system/statistics

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