diff --git a/tests/Logout.bru b/tests/Logout.bru index a1842f3..56641ec 100644 --- a/tests/Logout.bru +++ b/tests/Logout.bru @@ -23,3 +23,10 @@ settings { encodeUrl: true timeout: 0 } + +docs { + # /users/logout + + Permet de se déconnecter. + Supprime le remember_token et cookies de connexions. +} diff --git a/tests/Users/Create user.bru b/tests/Users/Create user.bru index 0fedbfc..4046e53 100644 --- a/tests/Users/Create user.bru +++ b/tests/Users/Create user.bru @@ -40,5 +40,9 @@ settings { } docs { - Créer un utilisateur test + # /users/register + + Permet de créer un compte utilisateur. + + Entrées: name, lastname, email, password } diff --git a/tests/Users/Delete user by id.bru b/tests/Users/Delete user by id.bru index 633709f..ed767dc 100644 --- a/tests/Users/Delete user by id.bru +++ b/tests/Users/Delete user by id.bru @@ -5,7 +5,7 @@ meta { } delete { - url: {{url}}/api/users/7 + url: {{url}}/api/users/{{id}} body: none auth: inherit } @@ -14,7 +14,24 @@ headers { X-XSRF-TOKEN: } +vars:pre-request { + id: 2 +} + settings { encodeUrl: true timeout: 0 } + +docs { + # /users/id + + + Permet de supprimer un compte utilisateur + + La connexion est obligatoire, les cookies de connexions/XSRF doivent être présents. + + L'utilisateur doit être admin poir supprimer un autre compte utilisateur. + + Entrée: id +} diff --git a/tests/Users/Delete user.bru b/tests/Users/Delete user.bru index 95fee60..281942f 100644 --- a/tests/Users/Delete user.bru +++ b/tests/Users/Delete user.bru @@ -19,3 +19,11 @@ settings { encodeUrl: true timeout: 0 } + +docs { + # /users -- DELETE + + Permet de supprimer le compte de l'utilisateur actuellement connecté. + + La connexion est obligatoire, les cookies de connexions/XSRF doivent être présents. +} diff --git a/tests/Users/Get User.bru b/tests/Users/Get User.bru index d0f618e..058c093 100644 --- a/tests/Users/Get User.bru +++ b/tests/Users/Get User.bru @@ -5,11 +5,15 @@ meta { } get { - url: {{url}}/api/users/5 + url: {{url}}/api/users/{{id}} body: none auth: inherit } +vars:pre-request { + id: 2 +} + settings { encodeUrl: true timeout: 0 @@ -18,6 +22,7 @@ settings { docs { Permet de récupérer les informations d'un utilisateur. Authetification demandée + Cookies de connexion/XSRF requis. /api/users/{ID} diff --git a/tests/Users/Modify user role.bru b/tests/Users/Modify user role.bru index 8d95cef..fbf78b8 100644 --- a/tests/Users/Modify user role.bru +++ b/tests/Users/Modify user role.bru @@ -5,7 +5,7 @@ meta { } post { - url: {{url}}/api/users/5/role + url: {{url}}/api/users/{{id}}/role body: json auth: inherit } @@ -23,6 +23,7 @@ body:json { vars:pre-request { role: 2 + id: 2 } assert { @@ -33,3 +34,15 @@ settings { encodeUrl: true timeout: 0 } + +docs { + # /users/id/role + + Permet de modifier le rôle d'un utilisateur. + + La connexion est obligatoire, les cookies de connexions/XSRF doivent être présents. + + L'utilisateur doit être admin pour modifier le rôle d'un utilisateur. + + Entrées: id, role +} diff --git a/tests/Users/Update User.bru b/tests/Users/Update User.bru index 0c10882..85ba0e1 100644 --- a/tests/Users/Update User.bru +++ b/tests/Users/Update User.bru @@ -39,7 +39,13 @@ settings { } docs { - Permet de modifier le nom, le prenom et le numéro de téléphone de l'utilisateur + # /users/update - le nom, le prenom et le numéro sont requis en entrée (même si pas modifié) + Permet de modifier les données de l'utilisateur actuellement connecté. + + La connexion est obligatoire, les cookies de connexions/XSRF doivent être présents. + + Entrées: name, lastname, phone + + Toutes les données d'entrées sont requises, même celles non modifiées. } diff --git a/tests/Users/Validate User.bru b/tests/Users/Validate User.bru index dfe4089..3077122 100644 --- a/tests/Users/Validate User.bru +++ b/tests/Users/Validate User.bru @@ -5,7 +5,7 @@ meta { } post { - url: {{url}}/api/users/5/validate + url: {{url}}/api/users/{{id}}/validate body: none auth: inherit } @@ -15,7 +15,23 @@ headers { X-XSRF-TOKEN: } +vars:pre-request { + id: 2 +} + settings { encodeUrl: true timeout: 0 } + +docs { + # /users/id/validate + + Permet de valider l'inscription d'un nouvel utilisateur. + + La connexion est obligatoire, les cookies de connexions/XSRF doivent être présents. + + L'utilisateur doit être admin pour valider un autre utilisateur + + Entrée: id: identifiant de l'utilisateur qui va être validé. +} diff --git a/tests/Users/get all users.bru b/tests/Users/get all users.bru index d2227be..ac9cc71 100644 --- a/tests/Users/get all users.bru +++ b/tests/Users/get all users.bru @@ -14,3 +14,9 @@ settings { encodeUrl: true timeout: 0 } + +docs { + # /users + + Permet de récupérer tous les IDs des utilisateurs. +} diff --git a/tests/get CSRF.bru b/tests/get CSRF.bru index cc6845b..713d9bc 100644 --- a/tests/get CSRF.bru +++ b/tests/get CSRF.bru @@ -18,3 +18,9 @@ settings { encodeUrl: true timeout: 0 } + +docs { + # /csrf-cookie + + Renvoi le cookie XSRF permettant de se connecter et de faire des requêtes afin d'éviter les failles CSRF. +} diff --git a/tests/me.bru b/tests/me.bru index c75a494..a3193de 100644 --- a/tests/me.bru +++ b/tests/me.bru @@ -5,7 +5,7 @@ meta { } get { - url: {{url}}/api/me + url: {{url}}/api/users/me body: none auth: inherit } @@ -22,3 +22,13 @@ settings { encodeUrl: true timeout: 0 } + +docs { + # /me + + Renvoi l'utilisateur acutllement connecté. + + La connexion est obligatoire, les cookies de connexions/XSRF doivent être présents. + + Renvoi un objet avec les informations de l'utilisateur +}